Skip to content

Commit 390041b

Browse files
bitjsonbitjson
authored
feat: TS v4, tslint -> eslint, add cspell support (#240)
Update all dependencies, migrate from tslint (deprecated) to typescript-eslint, and add support for cspell. BREAKING CHANGE: migrated from tslint (deprecated) to eslint.
1 parent ab50e80 commit 390041b

31 files changed

+6528
-4300
lines changed

‎.circleci/config.yml

+18-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ jobs:
44
'node-10':
55
docker:
66
- image: circleci/node:10
7-
working_directory: ~/typescript-starter
87
steps:
98
- checkout
109
# Download and cache dependencies
@@ -21,10 +20,26 @@ jobs:
2120
- run: npm test
2221
- run: npm run cov:send
2322
- run: npm run cov:check
23+
'node-12':
24+
docker:
25+
- image: circleci/node:12
26+
steps:
27+
- checkout
28+
- restore_cache:
29+
keys:
30+
- v1-dependencies-{{ checksum "package.json" }}
31+
- v1-dependencies-
32+
- run: npm install
33+
- save_cache:
34+
paths:
35+
- node_modules
36+
key: v1-dependencies-{{ checksum "package.json" }}
37+
- run: npm test
38+
- run: npm run cov:send
39+
- run: npm run cov:check
2440
'node-latest':
2541
docker:
2642
- image: circleci/node:latest
27-
working_directory: ~/typescript-starter
2843
steps:
2944
- checkout
3045
- restore_cache:
@@ -45,4 +60,5 @@ workflows:
4560
build:
4661
jobs:
4762
- 'node-10'
63+
- 'node-12'
4864
- 'node-latest'

‎.cspell.json

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"version": "0.1",
3+
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/master/cspell.schema.json",
4+
"language": "en",
5+
"words": [
6+
"bitjson",
7+
"bitauth",
8+
"cimg",
9+
"circleci",
10+
"codecov",
11+
"commitlint",
12+
"dependabot",
13+
"editorconfig",
14+
"execa",
15+
"exponentiate",
16+
"globby",
17+
"libauth",
18+
"mkdir",
19+
"prettierignore",
20+
"sandboxed",
21+
"transpiled",
22+
"typedoc",
23+
"untracked"
24+
],
25+
"flagWords": [],
26+
"ignorePaths": [
27+
"package.json",
28+
"package-lock.json",
29+
"yarn.lock",
30+
"tsconfig.json",
31+
"node_modules/**"
32+
]
33+
}

‎.eslintrc.json

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"root": true,
3+
"parser": "@typescript-eslint/parser",
4+
"parserOptions": { "project": "./tsconfig.json" },
5+
"env": { "es6": true },
6+
"ignorePatterns": ["node_modules", "build", "coverage"],
7+
"plugins": ["import", "eslint-comments", "functional"],
8+
"extends": [
9+
"eslint:recommended",
10+
"plugin:eslint-comments/recommended",
11+
"plugin:@typescript-eslint/recommended",
12+
"plugin:import/typescript",
13+
"plugin:functional/lite",
14+
"prettier",
15+
"prettier/@typescript-eslint"
16+
],
17+
"globals": { "BigInt": true, "console": true, "WebAssembly": true },
18+
"rules": {
19+
"@typescript-eslint/explicit-module-boundary-types": "off",
20+
"eslint-comments/disable-enable-pair": [
21+
"error",
22+
{ "allowWholeFile": true }
23+
],
24+
"eslint-comments/no-unused-disable": "error",
25+
"import/order": [
26+
"error",
27+
{ "newlines-between": "always", "alphabetize": { "order": "asc" } }
28+
],
29+
"sort-imports": [
30+
"error",
31+
{ "ignoreDeclarationSort": true, "ignoreCase": true }
32+
]
33+
}
34+
}

‎.github/ISSUE_TEMPLATE.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
* **I'm submitting a ...**
2-
[ ] bug report
3-
[ ] feature request
4-
[ ] question about the decisions made in the repository
5-
[ ] question about how to use this project
1+
- **I'm submitting a ...**
2+
[ ] bug report
3+
[ ] feature request
4+
[ ] question about the decisions made in the repository
5+
[ ] question about how to use this project
66

7-
* **Summary**
7+
- **Summary**
88

9-
10-
11-
* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)
9+
- **Other information** (e.g. detailed explanation, stack traces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

‎.github/PULL_REQUEST_TEMPLATE.md

+4-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
1-
* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
1+
- **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
22

3+
- **What is the current behavior?** (You can also link to an open issue here)
34

5+
- **What is the new behavior (if this is a feature change)?**
46

5-
* **What is the current behavior?** (You can also link to an open issue here)
6-
7-
8-
9-
* **What is the new behavior (if this is a feature change)?**
10-
11-
12-
13-
* **Other information**:
7+
- **Other information**:

‎.npmignore

-14
This file was deleted.

‎.vscode/debug-ts.js

-52
This file was deleted.

‎.vscode/extensions.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"recommendations": [
3+
"dbaeumer.vscode-eslint",
4+
"esbenp.prettier-vscode",
5+
"eamodio.gitlens",
6+
"streetsidesoftware.code-spell-checker",
7+
]
8+
}

‎.vscode/launch.json

+28-68
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,44 @@
11
{
22
"version": "0.2.0",
3-
"configurations": [{
4-
"type": "node",
5-
"request": "launch",
6-
"name": "Debug Project",
7-
// we test in `build` to make cleanup fast and easy
8-
"cwd": "${workspaceFolder}/build",
9-
// Replace this with your project root. If there are multiple, you can
10-
// automatically run the currently visible file with: "program": ${file}"
11-
"program": "${workspaceFolder}/src/cli/cli.ts",
12-
// "args": ["--no-install"],
13-
"outFiles": ["${workspaceFolder}/build/main/**/*.js"],
14-
"skipFiles": [
15-
"<node_internals>/**/*.js",
16-
"${workspaceFolder}/node_modules/**/*.js"
17-
],
18-
"preLaunchTask": "npm: build",
19-
"stopOnEntry": true,
20-
"smartStep": true,
21-
"runtimeArgs": ["--nolazy"],
22-
"env": {
23-
"TYPESCRIPT_STARTER_REPO_URL": "${workspaceFolder}"
24-
},
25-
"console": "externalTerminal"
26-
},
3+
"configurations": [
4+
// To debug, make sure a *.spec.ts file is active in the editor, then run a configuration
275
{
286
"type": "node",
297
"request": "launch",
30-
"name": "Debug Spec",
31-
"program": "${workspaceRoot}/.vscode/debug-ts.js",
32-
"args": ["${file}"],
8+
"name": "Debug Active Spec",
9+
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/ava",
10+
"runtimeArgs": ["debug", "--break", "--serial", "${file}"],
11+
"port": 9229,
12+
"outputCapture": "std",
3313
"skipFiles": ["<node_internals>/**/*.js"],
34-
// Consider using `npm run watch` or `yarn watch` for faster debugging
35-
// "preLaunchTask": "npm: build",
36-
// "smartStep": true,
37-
"runtimeArgs": ["--nolazy"]
14+
"preLaunchTask": "npm: build"
15+
// "smartStep": true
3816
},
39-
// --- cut here ---
40-
// TODO: Simpler test debugging option. Discussion:
41-
// https://github.com/avajs/ava/issues/1505#issuecomment-370654427
42-
// {
43-
// "type": "node",
44-
// "request": "launch",
45-
// "name": "Debug Visible Compiled Spec",
46-
// "program": "${file}",
47-
// "outFiles": ["${workspaceFolder}/build/main/**/*.js"],
48-
// "skipFiles": ["<node_internals>/**/*.js"],
49-
// // Consider using `npm run watch` or `yarn watch` for faster debugging
50-
// // "preLaunchTask": "npm: build",
51-
// // "stopOnEntry": true,
52-
// // "smartStep": true,
53-
// "runtimeArgs": ["--nolazy"],
54-
// "env": {
55-
// "AVA_DEBUG_MODE": "1"
56-
// }
57-
// }
58-
// CLI:
5917
{
18+
// Use this one if you're already running `yarn watch`
6019
"type": "node",
6120
"request": "launch",
62-
"name": "Debug CLI Unit Tests",
63-
"program": "${workspaceFolder}/node_modules/ava/profile.js",
64-
"args": ["${workspaceFolder}/build/main/cli/tests/cli.unit.spec.js"],
65-
"skipFiles": ["<node_internals>/**/*.js"],
66-
// "preLaunchTask": "npm: build",
67-
// "smartStep": true,
68-
"runtimeArgs": ["--nolazy"]
21+
"name": "Debug Active Spec (no build)",
22+
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/ava",
23+
"runtimeArgs": ["debug", "--break", "--serial", "${file}"],
24+
"port": 9229,
25+
"outputCapture": "std",
26+
"skipFiles": ["<node_internals>/**/*.js"]
27+
// "smartStep": true
6928
},
29+
// --- cut here ---
30+
// CLI:
7031
{
7132
"type": "node",
7233
"request": "launch",
73-
"name": "Debug CLI Integration Tests",
74-
"program": "${workspaceFolder}/node_modules/ava/profile.js",
75-
"args": [
76-
"${workspaceFolder}/build/main/cli/tests/cli.integration.spec.js"
77-
],
78-
"skipFiles": ["<node_internals>/**/*.js"],
79-
// "preLaunchTask": "npm: build",
80-
// "smartStep": true,
81-
"runtimeArgs": ["--nolazy"]
34+
"name": "Try CLI",
35+
"program": "${workspaceFolder}/bin/typescript-starter",
36+
"cwd": "${workspaceFolder}/build",
37+
"env": {
38+
"TYPESCRIPT_STARTER_REPO_URL": "${workspaceFolder}"
39+
},
40+
"args": ["debug"],
41+
"skipFiles": ["<node_internals>/**/*.js"]
8242
}
8343
]
84-
}
44+
}

‎.vscode/settings.json

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
2-
"typescript.tsdk": "node_modules/typescript/lib"
3-
// "typescript.implementationsCodeLens.enabled": true
4-
// "typescript.referencesCodeLens.enabled": true
2+
"cSpell.userWords": [], // only use words from .cspell.json
3+
"cSpell.enabled": true,
4+
"editor.formatOnSave": true,
5+
"typescript.tsdk": "node_modules/typescript/lib",
6+
"typescript.enablePromptUseWorkspaceTsdk": true
57
}

0 commit comments

Comments
 (0)