Skip to content

Commit 71871cd

Browse files
* Update dependencies
* Use ESLint instead of TSLint * Use npm instead of gulp
1 parent 9ed96ac commit 71871cd

17 files changed

+1696
-4801
lines changed

.eslintignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
examples
2+
node_modules
3+
lib
4+
docs

.eslintrc.js

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
/**
2+
* Copyright (C) 2020 Michael Kourlas
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
"use strict";
18+
19+
module.exports = {
20+
env: {
21+
node: true
22+
},
23+
root: true,
24+
parser: '@typescript-eslint/parser',
25+
plugins: [
26+
'@typescript-eslint'
27+
],
28+
extends: [
29+
'eslint:recommended',
30+
'plugin:@typescript-eslint/eslint-recommended',
31+
'plugin:@typescript-eslint/recommended'
32+
],
33+
rules: {
34+
// Maximum line length of 80
35+
'max-len': ['error', {'code': 80}],
36+
37+
// Too late to change this, since interfaces are part of the public API
38+
'@typescript-eslint/interface-name-prefix': 0,
39+
40+
// Too much noise
41+
'@typescript-eslint/explicit-function-return-type': 0,
42+
43+
// Allow private functions at bottom of file
44+
'@typescript-eslint/no-use-before-define': 0,
45+
46+
// Allow private constructors
47+
'@typescript-eslint/no-empty-function': ["error",
48+
{"allow": ["private-constructors"]}]
49+
}
50+
};

.travis.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,5 @@ node_js:
44
- 8
55
- 10
66
install:
7-
- npm install -g gulp
87
- npm install
9-
script: gulp
8+
script: npm run-script build

CHANGES.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## 4.0.1 ##
2+
3+
* Update dependencies
4+
* Use ESLint instead of TSLint
5+
* Use npm instead of gulp
6+
17
## 4.0.0 ##
28

39
* Do not indent multi-line strings

NOTICE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
js2xmlparser
2-
Copyright (C) 2016-2019 Michael Kourlas
2+
Copyright (C) 2016-2020 Michael Kourlas
33

44
## Apache License, version 2.0 ##
55

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

88
xmlcreate
9-
Copyright (C) 2016-2019 Michael Kourlas
9+
Copyright (C) 2016-2020 Michael Kourlas

README.md

+14-23
Original file line numberDiff line numberDiff line change
@@ -40,38 +40,30 @@ The easiest way to install js2xmlparser is using npm:
4040
npm install js2xmlparser
4141
```
4242

43-
You can also build js2xmlparser from source using gulp:
43+
You can also build js2xmlparser from source using npm:
4444

4545
```
4646
git clone https://github.com/michaelkourlas/node-js2xmlparser.git
4747
npm install
48-
gulp
48+
npm run-script build
4949
```
5050

51-
You'll need to install gulp first if you don't have it:
52-
53-
```
54-
npm install -g gulp
55-
```
56-
57-
You can then copy the folder into your node_modules directory.
58-
59-
The `default` target will build the production variant of js2xmlparser, run all
51+
The `build` script will build the production variant of js2xmlparser, run all
6052
tests, and build the documentation.
6153

62-
You can build the production variant without running tests using the target
63-
`prod`. You can also build the development version using the target `dev`. At
64-
the moment, the only difference between the two is that the development version
65-
includes source maps.
54+
You can build the production variant without running tests using the script
55+
`prod`. You can also build the development version using the script `dev`.
56+
The only difference between the two is that the development version includes
57+
source maps.
6658

6759
## Usage ##
6860

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

71-
You can also build the documentation using gulp:
63+
You can also build the documentation using npm:
7264

7365
```
74-
gulp docs
66+
npm run-script docs
7567
```
7668

7769
## Examples ##
@@ -146,15 +138,14 @@ Additional examples can be found in the examples directory.
146138
## Tests ##
147139

148140
js2xmlparser includes a set of tests to verify core functionality. You can run
149-
the tests using gulp:
141+
the tests using npm:
150142

151143
```
152-
gulp test
144+
npm run-script test-prod
153145
```
154146

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

159150
## License ##
160151

gulpfile.js

-130
This file was deleted.

0 commit comments

Comments
 (0)