complete-lint 1.4.0 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +11 -2
  3. package/package.json +3 -3
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright The Complete Contributors
3
+ Copyright (c) 2024 The Complete Contributors
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6
6
 
package/README.md CHANGED
@@ -156,6 +156,7 @@ await lintScript(async () => {
156
156
  const promises = [
157
157
  // Use TypeScript to type-check the code.
158
158
  $`tsc --noEmit`,
159
+ $`tsc --noEmit --project ./scripts/tsconfig.json`,
159
160
 
160
161
  // Use ESLint to lint the TypeScript code.
161
162
  // - "--max-warnings 0" makes warnings fail, since we set all ESLint errors to warnings.
@@ -180,7 +181,15 @@ await lintScript(async () => {
180
181
  });
181
182
  ```
182
183
 
183
- If you want, you can also put the script in your "package.json" file:
184
+ Or, if you want to abstract this away, you can simplify the script by using a helper function:
185
+
186
+ ```ts
187
+ import { lintScript, standardLintFunction } from "complete-node";
188
+
189
+ await lintScript(standardLintFunction);
190
+ ```
191
+
192
+ Additionally, you can also optionally put the script in your "package.json" file:
184
193
 
185
194
  ```json
186
195
  "scripts": {
@@ -188,7 +197,7 @@ If you want, you can also put the script in your "package.json" file:
188
197
  },
189
198
  ```
190
199
 
191
- That allows you to type `npm run lint` to more easily run the script.
200
+ That allows you to type `npm run lint` in order to more easily run the script.
192
201
 
193
202
  ### Step 6 - Lint in CI
194
203
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "complete-lint",
3
- "version": "1.4.0",
3
+ "version": "1.6.0",
4
4
  "description": "A linting dependency meta-package for TypeScript projects.",
5
5
  "keywords": [
6
6
  "lint",
@@ -27,10 +27,10 @@
27
27
  "dependencies": {
28
28
  "@prettier/plugin-xml": "^3.4.1",
29
29
  "@types/node": "^22.5.4",
30
- "complete-node": "^1.1.0",
30
+ "complete-node": "^1.3.0",
31
31
  "complete-tsconfig": "^1.0.0",
32
32
  "cspell": "^8.14.2",
33
- "cspell-check-unused-words": "^1.3.1",
33
+ "cspell-check-unused-words": "^1.3.2",
34
34
  "eslint": "^9.10.0",
35
35
  "eslint-config-complete": "^1.2.0",
36
36
  "eslint-import-resolver-typescript": "^3.6.3",