Skip to content

Commit

Permalink
* Update dependencies
Browse files Browse the repository at this point in the history
* Use ESLint instead of TSLint
* Use npm instead of gulp
  • Loading branch information
michaelkourlas committed Feb 2, 2020
1 parent 9ed96ac commit 71871cd
Show file tree
Hide file tree
Showing 17 changed files with 1,696 additions and 4,801 deletions.
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
examples
node_modules
lib
docs
50 changes: 50 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/**
* Copyright (C) 2020 Michael Kourlas
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

"use strict";

module.exports = {
env: {
node: true
},
root: true,
parser: '@typescript-eslint/parser',
plugins: [
'@typescript-eslint'
],
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/eslint-recommended',
'plugin:@typescript-eslint/recommended'
],
rules: {
// Maximum line length of 80
'max-len': ['error', {'code': 80}],

// Too late to change this, since interfaces are part of the public API
'@typescript-eslint/interface-name-prefix': 0,

// Too much noise
'@typescript-eslint/explicit-function-return-type': 0,

// Allow private functions at bottom of file
'@typescript-eslint/no-use-before-define': 0,

// Allow private constructors
'@typescript-eslint/no-empty-function': ["error",
{"allow": ["private-constructors"]}]
}
};
3 changes: 1 addition & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@ node_js:
- 8
- 10
install:
- npm install -g gulp
- npm install
script: gulp
script: npm run-script build
6 changes: 6 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 4.0.1 ##

* Update dependencies
* Use ESLint instead of TSLint
* Use npm instead of gulp

## 4.0.0 ##

* Do not indent multi-line strings
Expand Down
4 changes: 2 additions & 2 deletions NOTICE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
js2xmlparser
Copyright (C) 2016-2019 Michael Kourlas
Copyright (C) 2016-2020 Michael Kourlas

## Apache License, version 2.0 ##

The following components are provided under the [Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0):

xmlcreate
Copyright (C) 2016-2019 Michael Kourlas
Copyright (C) 2016-2020 Michael Kourlas
37 changes: 14 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,38 +40,30 @@ The easiest way to install js2xmlparser is using npm:
npm install js2xmlparser
```

You can also build js2xmlparser from source using gulp:
You can also build js2xmlparser from source using npm:

```
git clone https://github.com/michaelkourlas/node-js2xmlparser.git
npm install
gulp
npm run-script build
```

You'll need to install gulp first if you don't have it:

```
npm install -g gulp
```

You can then copy the folder into your node_modules directory.

The `default` target will build the production variant of js2xmlparser, run all
The `build` script will build the production variant of js2xmlparser, run all
tests, and build the documentation.

You can build the production variant without running tests using the target
`prod`. You can also build the development version using the target `dev`. At
the moment, the only difference between the two is that the development version
includes source maps.
You can build the production variant without running tests using the script
`prod`. You can also build the development version using the script `dev`.
The only difference between the two is that the development version includes
source maps.

## Usage ##

The documentation for the current version is available [here](http://www.kourlas.com/node-js2xmlparser/docs/4.0.0/).
The documentation for the current version is available [here](http://www.kourlas.com/node-js2xmlparser/docs/4.0.1/).

You can also build the documentation using gulp:
You can also build the documentation using npm:

```
gulp docs
npm run-script docs
```

## Examples ##
Expand Down Expand Up @@ -146,15 +138,14 @@ Additional examples can be found in the examples directory.
## Tests ##

js2xmlparser includes a set of tests to verify core functionality. You can run
the tests using gulp:
the tests using npm:

```
gulp test
npm run-script test-prod
```

The `test` target builds the production variant of js2xmlparser before running
the tests. The `test-prod` target does the same thing, while the `test-dev`
target builds the development variant first instead.
The only difference between the `test-prod` and `test-dev` scripts is that the
development version includes source maps.

## License ##

Expand Down
130 changes: 0 additions & 130 deletions gulpfile.js

This file was deleted.

Loading

0 comments on commit 71871cd

Please sign in to comment.