@ms-cloudpack/eslint-plugin 0.2.0 → 0.2.1

package/README.md

@@ -6,9 +6,7 @@
 
 ### Recommended
 
-This config includes rules that are recommended for helping Cloudpack work better in your repo.
-
-To enable the `@ms-cloudpack/recommended` configuration, add it to your ESLint config file:
+The `@ms-cloudpack/recommended` config includes rules that are recommended for helping Cloudpack work better in your repo. None of these rules require type checking. To enable:
 
 ```json
 {
@@ -17,11 +15,34 @@ To enable the `@ms-cloudpack/recommended` configuration, add it to your ESLint c
 }
 ```
 
-`@ms-cloudpack/recommended` currently includes the following rules.
+`@ms-cloudpack/recommended` includes the following rules:
 
 - `@ms-cloudpack/no-unsupported-imports`
 - [`@rnx-kit/no-const-enum](https://www.npmjs.com/package/@rnx-kit/eslint-plugin)
 - [`@rnx-kit/no-export-all](https://www.npmjs.com/package/@rnx-kit/eslint-plugin)
+
+### Recommended requiring type checking
+
+The `@ms-cloudpack/recommended-requiring-type-checking` config includes additional rules which are helpful for Cloudpack but require type information. Following the pattern of typescript-eslint, this config **does not** include the rules from the basic "recommended" config.
+
+To enable, follow the instructions for [linting with type information](https://typescript-eslint.io/linting/typed-linting), then add the config to `extends`:
+
+```jsonc
+{
+  "plugins": ["@ms-cloudpack"],
+  "extends": [
+    // Both of these should be included
+    "plugin:@ms-cloudpack/recommended",
+    "plugin:@ms-cloudpack/recommended-requiring-type-checking"
+  ],
+  "parserOptions": {
+    // `project` must be specified; see link above
+  }
+}
+```
+
+`@ms-cloudpack/recommended-requiring-type-checking` includes the following rules:
+
 - [`@typescript-eslint/consistent-type-exports`](https://typescript-eslint.io/rules/consistent-type-exports)
 - [`@typescript-eslint/consistent-type-imports`](https://typescript-eslint.io/rules/consistent-type-imports)
 
@@ -29,6 +50,10 @@ To enable the `@ms-cloudpack/recommended` configuration, add it to your ESLint c
 
 The `@ms-cloudpack/onboarding` config includes the same rules as `@ms-cloudpack/recommended`, but at `warn` level.
 
+### Onboarding requiring type checking
+
+The `@ms-cloudpack/onboarding-requiring-type-checking` config includes the same rules as `@ms-cloudpack/recommended-requiring-type-checking`, but at `warn` level. Following the pattern of typescript-eslint, this config **does not** include the rules from the basic "onboarding" config.
+
 ## Included rules
 
 - ✓: Enabled with `@ms-cloudpack/recommended`

package/lib/configs/onboarding-requiring-type-checking.d.ts

@@ -0,0 +1,3 @@
+import type { ESLint } from 'eslint';
+export declare const onboardingRequiringTypeChecking: ESLint.ConfigData;
+//# sourceMappingURL=onboarding-requiring-type-checking.d.ts.map

package/lib/configs/onboarding-requiring-type-checking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding-requiring-type-checking.d.ts","sourceRoot":"","sources":["../../src/configs/onboarding-requiring-type-checking.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGrC,eAAO,MAAM,+BAA+B,EAAE,MAAM,CAAC,UAIpD,CAAC"}

package/lib/configs/onboarding-requiring-type-checking.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onboardingRequiringTypeChecking = void 0;
+const recommended_requiring_type_checking_1 = require("./recommended-requiring-type-checking");
+exports.onboardingRequiringTypeChecking = {
+    ...recommended_requiring_type_checking_1.recommendedRequiringTypeChecking,
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    rules: Object.fromEntries(Object.keys(recommended_requiring_type_checking_1.recommendedRequiringTypeChecking.rules).map((rule) => [rule, 'warn'])),
+};
+//# sourceMappingURL=onboarding-requiring-type-checking.js.map

package/lib/configs/onboarding-requiring-type-checking.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding-requiring-type-checking.js","sourceRoot":"","sources":["../../src/configs/onboarding-requiring-type-checking.ts"],"names":[],"mappings":";;;AACA,+FAAyF;AAE5E,QAAA,+BAA+B,GAAsB;IAChE,GAAG,sEAAgC;IACnC,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,sEAAgC,CAAC,KAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;CAC9G,CAAC","sourcesContent":["import type { ESLint } from 'eslint';\nimport { recommendedRequiringTypeChecking } from './recommended-requiring-type-checking';\n\nexport const onboardingRequiringTypeChecking: ESLint.ConfigData = {\n  ...recommendedRequiringTypeChecking,\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n  rules: Object.fromEntries(Object.keys(recommendedRequiringTypeChecking.rules!).map((rule) => [rule, 'warn'])),\n};\n"]}

package/lib/configs/onboarding.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.onboarding = void 0;
 const recommended_1 = require("./recommended");
 exports.onboarding = {
-    plugins: ['@ms-cloudpack', '@rnx-kit', '@typescript-eslint'],
+    ...recommended_1.recommended,
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     rules: Object.fromEntries(Object.keys(recommended_1.recommended.rules).map((rule) => [rule, 'warn'])),
 };

package/lib/configs/onboarding.js.map

@@ -1 +1 @@
-{"version":3,"file":"onboarding.js","sourceRoot":"","sources":["../../src/configs/onboarding.ts"],"names":[],"mappings":";;;AACA,+CAA4C;AAE/B,QAAA,UAAU,GAAsB;IAC3C,OAAO,EAAE,CAAC,eAAe,EAAE,UAAU,EAAE,oBAAoB,CAAC;IAC5D,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,yBAAW,CAAC,KAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;CACzF,CAAC","sourcesContent":["import type { ESLint } from 'eslint';\nimport { recommended } from './recommended';\n\nexport const onboarding: ESLint.ConfigData = {\n  plugins: ['@ms-cloudpack', '@rnx-kit', '@typescript-eslint'],\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n  rules: Object.fromEntries(Object.keys(recommended.rules!).map((rule) => [rule, 'warn'])),\n};\n"]}
+{"version":3,"file":"onboarding.js","sourceRoot":"","sources":["../../src/configs/onboarding.ts"],"names":[],"mappings":";;;AACA,+CAA4C;AAE/B,QAAA,UAAU,GAAsB;IAC3C,GAAG,yBAAW;IACd,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,yBAAW,CAAC,KAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;CACzF,CAAC","sourcesContent":["import type { ESLint } from 'eslint';\nimport { recommended } from './recommended';\n\nexport const onboarding: ESLint.ConfigData = {\n  ...recommended,\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n  rules: Object.fromEntries(Object.keys(recommended.rules!).map((rule) => [rule, 'warn'])),\n};\n"]}

package/lib/configs/recommended-requiring-type-checking.d.ts

@@ -0,0 +1,3 @@
+import type { ESLint } from 'eslint';
+export declare const recommendedRequiringTypeChecking: ESLint.ConfigData;
+//# sourceMappingURL=recommended-requiring-type-checking.d.ts.map

package/lib/configs/recommended-requiring-type-checking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommended-requiring-type-checking.d.ts","sourceRoot":"","sources":["../../src/configs/recommended-requiring-type-checking.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,eAAO,MAAM,gCAAgC,EAAE,MAAM,CAAC,UAMrD,CAAC"}

package/lib/configs/recommended-requiring-type-checking.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recommendedRequiringTypeChecking = void 0;
+exports.recommendedRequiringTypeChecking = {
+    plugins: ['@typescript-eslint'],
+    rules: {
+        '@typescript-eslint/consistent-type-imports': 'error',
+        '@typescript-eslint/consistent-type-exports': 'error',
+    },
+};
+//# sourceMappingURL=recommended-requiring-type-checking.js.map

package/lib/configs/recommended-requiring-type-checking.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommended-requiring-type-checking.js","sourceRoot":"","sources":["../../src/configs/recommended-requiring-type-checking.ts"],"names":[],"mappings":";;;AAEa,QAAA,gCAAgC,GAAsB;IACjE,OAAO,EAAE,CAAC,oBAAoB,CAAC;IAC/B,KAAK,EAAE;QACL,4CAA4C,EAAE,OAAO;QACrD,4CAA4C,EAAE,OAAO;KACtD;CACF,CAAC","sourcesContent":["import type { ESLint } from 'eslint';\n\nexport const recommendedRequiringTypeChecking: ESLint.ConfigData = {\n  plugins: ['@typescript-eslint'],\n  rules: {\n    '@typescript-eslint/consistent-type-imports': 'error',\n    '@typescript-eslint/consistent-type-exports': 'error',\n  },\n};\n"]}

package/lib/configs/recommended.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recommended.d.ts","sourceRoot":"","sources":["../../src/configs/recommended.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,UAShC,CAAC"}
+{"version":3,"file":"recommended.d.ts","sourceRoot":"","sources":["../../src/configs/recommended.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,UAOhC,CAAC"}

package/lib/configs/recommended.js

@@ -7,8 +7,6 @@ exports.recommended = {
         '@ms-cloudpack/no-unsupported-imports': 'error',
         '@rnx-kit/no-const-enum': 'error',
         '@rnx-kit/no-export-all': 'error',
-        '@typescript-eslint/consistent-type-imports': 'error',
-        '@typescript-eslint/consistent-type-exports': 'error',
     },
 };
 //# sourceMappingURL=recommended.js.map

package/lib/configs/recommended.js.map

@@ -1 +1 @@
-{"version":3,"file":"recommended.js","sourceRoot":"","sources":["../../src/configs/recommended.ts"],"names":[],"mappings":";;;AAEa,QAAA,WAAW,GAAsB;IAC5C,OAAO,EAAE,CAAC,eAAe,EAAE,UAAU,EAAE,oBAAoB,CAAC;IAC5D,KAAK,EAAE;QACL,sCAAsC,EAAE,OAAO;QAC/C,wBAAwB,EAAE,OAAO;QACjC,wBAAwB,EAAE,OAAO;QACjC,4CAA4C,EAAE,OAAO;QACrD,4CAA4C,EAAE,OAAO;KACtD;CACF,CAAC","sourcesContent":["import type { ESLint } from 'eslint';\n\nexport const recommended: ESLint.ConfigData = {\n  plugins: ['@ms-cloudpack', '@rnx-kit', '@typescript-eslint'],\n  rules: {\n    '@ms-cloudpack/no-unsupported-imports': 'error',\n    '@rnx-kit/no-const-enum': 'error',\n    '@rnx-kit/no-export-all': 'error',\n    '@typescript-eslint/consistent-type-imports': 'error',\n    '@typescript-eslint/consistent-type-exports': 'error',\n  },\n};\n"]}
+{"version":3,"file":"recommended.js","sourceRoot":"","sources":["../../src/configs/recommended.ts"],"names":[],"mappings":";;;AAEa,QAAA,WAAW,GAAsB;IAC5C,OAAO,EAAE,CAAC,eAAe,EAAE,UAAU,EAAE,oBAAoB,CAAC;IAC5D,KAAK,EAAE;QACL,sCAAsC,EAAE,OAAO;QAC/C,wBAAwB,EAAE,OAAO;QACjC,wBAAwB,EAAE,OAAO;KAClC;CACF,CAAC","sourcesContent":["import type { ESLint } from 'eslint';\n\nexport const recommended: ESLint.ConfigData = {\n  plugins: ['@ms-cloudpack', '@rnx-kit', '@typescript-eslint'],\n  rules: {\n    '@ms-cloudpack/no-unsupported-imports': 'error',\n    '@rnx-kit/no-const-enum': 'error',\n    '@rnx-kit/no-export-all': 'error',\n  },\n};\n"]}

package/lib/index.d.ts

@@ -1,7 +1,9 @@
 declare const _default: {
     configs: {
         onboarding: import("eslint").ESLint.ConfigData<import("eslint").Linter.RulesRecord>;
+        'onboarding-requiring-type-checking': import("eslint").ESLint.ConfigData<import("eslint").Linter.RulesRecord>;
         recommended: import("eslint").ESLint.ConfigData<import("eslint").Linter.RulesRecord>;
+        'recommended-requiring-type-checking': import("eslint").ESLint.ConfigData<import("eslint").Linter.RulesRecord>;
     };
     rules: {
         'no-unsupported-imports': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<import("./rules/no-unsupported-imports").MessageIds, import("./rules/no-unsupported-imports").RawRuleOptions[], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAIA,kBAQE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAMA,kBAUE"}

package/lib/index.js

@@ -1,11 +1,15 @@
 "use strict";
 const onboarding_1 = require("./configs/onboarding");
+const onboarding_requiring_type_checking_1 = require("./configs/onboarding-requiring-type-checking");
 const recommended_1 = require("./configs/recommended");
+const recommended_requiring_type_checking_1 = require("./configs/recommended-requiring-type-checking");
 const no_unsupported_imports_1 = require("./rules/no-unsupported-imports");
 module.exports = {
     configs: {
         onboarding: onboarding_1.onboarding,
+        'onboarding-requiring-type-checking': onboarding_requiring_type_checking_1.onboardingRequiringTypeChecking,
         recommended: recommended_1.recommended,
+        'recommended-requiring-type-checking': recommended_requiring_type_checking_1.recommendedRequiringTypeChecking,
     },
     rules: {
         'no-unsupported-imports': no_unsupported_imports_1.rule,

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,qDAAkD;AAClD,uDAAoD;AACpD,2EAA8E;AAE9E,iBAAS;IACP,OAAO,EAAE;QACP,UAAU,EAAV,uBAAU;QACV,WAAW,EAAX,yBAAW;KACZ;IACD,KAAK,EAAE;QACL,wBAAwB,EAAE,6BAAoB;KAC/C;CACF,CAAC","sourcesContent":["import { onboarding } from './configs/onboarding';\nimport { recommended } from './configs/recommended';\nimport { rule as noUnsupportedImports } from './rules/no-unsupported-imports';\n\nexport = {\n  configs: {\n    onboarding,\n    recommended,\n  },\n  rules: {\n    'no-unsupported-imports': noUnsupportedImports,\n  },\n};\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,qDAAkD;AAClD,qGAA+F;AAC/F,uDAAoD;AACpD,uGAAiG;AACjG,2EAA8E;AAE9E,iBAAS;IACP,OAAO,EAAE;QACP,UAAU,EAAV,uBAAU;QACV,oCAAoC,EAAE,oEAA+B;QACrE,WAAW,EAAX,yBAAW;QACX,qCAAqC,EAAE,sEAAgC;KACxE;IACD,KAAK,EAAE;QACL,wBAAwB,EAAE,6BAAoB;KAC/C;CACF,CAAC","sourcesContent":["import { onboarding } from './configs/onboarding';\nimport { onboardingRequiringTypeChecking } from './configs/onboarding-requiring-type-checking';\nimport { recommended } from './configs/recommended';\nimport { recommendedRequiringTypeChecking } from './configs/recommended-requiring-type-checking';\nimport { rule as noUnsupportedImports } from './rules/no-unsupported-imports';\n\nexport = {\n  configs: {\n    onboarding,\n    'onboarding-requiring-type-checking': onboardingRequiringTypeChecking,\n    recommended,\n    'recommended-requiring-type-checking': recommendedRequiringTypeChecking,\n  },\n  rules: {\n    'no-unsupported-imports': noUnsupportedImports,\n  },\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/eslint-plugin",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A set of ESLint rules for Cloudpack",
   "license": "MIT",
   "main": "lib/index.js",
@@ -13,7 +13,7 @@
     "test": "cloudpack-scripts test"
   },
   "dependencies": {
-    "@rnx-kit/eslint-plugin": "^0.4.0",
+    "@rnx-kit/eslint-plugin": "^0.4.2",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
     "resolve": "^1.22.0"