ts-ide-overrides - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "ts-ide-overrides",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "main": "./dist",
@@ -14,2 +14,5 @@ "repository": "https://github.com/ashsearle/ts-ide-overrides.git",
   },
+  "peerDependencies": {
+    "typescript": ">=4.0.0"
+  },
   "devDependencies": {
@@ -16,0 +19,0 @@ "typescript": "^4.7.4"

README.md

 # ts-ide-overrides
 
-This plugin allows you to override a subset of TypeScript `compilerOptions` when editing files in an IDE. (Specifically `strict` and its 8 associated options: `alwaysStrict`, `strictNullChecks`, `strictBindCallApply`, `strictFunctionTypes`, `strictPropertyInitialization`, `noImplicitAny`, `noImplicitThis`, `useUnknownInCatchVariables`.)
+TypeScript language service plugin to override _strict mode family_ options within an editor.
 
-The purpose of the plugin is to support gradual adoption of strict rules, without breaking pre-existing build and validation processes.
+The plugin helps raise visibility of strict mode issues without breaking your build process.
 
+The _strict mode family_ options are `strict` and the 8 related options: `alwaysStrict`, `strictNullChecks`, `strictBindCallApply`, `strictFunctionTypes`, `strictPropertyInitialization`, `noImplicitAny`, `noImplicitThis`, and `useUnknownInCatchVariables`.
+
+## Install
+
+Install as a dev-dependency using a package manager:
+
+```bash
+npm install --save-dev ts-ide-overrides
+```
+
+```bash
+yarn add --save-dev ts-ide-overrides
+```
+
+```bash
+pnpm add --save-dev ts-ide-overrides
+```
+
+```bash
+bun add --development ts-ide-overrides
+```
+
 ## Configuration
@@ -20,4 +42,5 @@
           // just an example...
-          "strictNullChecks": true,
-          "noImplicitAny": true
+          "strict": true,
+          "noImplicitAny": false,
+          "useUnknownInCatchVariables": false
         }
@@ -35,4 +58,3 @@ }
 ```ts
-// @ts-ide-disable-strict-null-checks
-/* @ts-ide-enable-no-implicit-this */
+// @ts-ide-disable-strict @ts-ide-enable-strict-null-checks
 ```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4455

increased by7.71%

Number of lines in readme file

59

increased by59.46%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

1

increased byInfinity%

No dependency changes