@microsoft/eslint-config-spfx 1.15.0-rc.0

package/README.md

@@ -0,0 +1,10 @@
+# eslint-config-spfx
+
+This package defines custom [ESLint](https://eslint.org/) rules for usage
+with SharePoint client-side projects.
+
+*This package is part of the [SharePoint Framework](http://aka.ms/spfx),
+which is a collection of NPM packages that empower developers to create client-side experiences
+for [Microsoft SharePoint](https://products.office.com/en-us/sharepoint/collaboration).
+For more information, including complete API documentation and code samples, please visit
+the [SharePoint Framework](http://aka.ms/spfx) web site.*

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export { default as Default } from './profiles/default';
+export { default as React } from './profiles/react';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,kBAAkB,CAAC"}

package/lib/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.React = exports.Default = void 0;
+var default_1 = require("./profiles/default");
+Object.defineProperty(exports, "Default", { enumerable: true, get: function () { return __importDefault(default_1).default; } });
+var react_1 = require("./profiles/react");
+Object.defineProperty(exports, "React", { enumerable: true, get: function () { return __importDefault(react_1).default; } });
+//# sourceMappingURL=index.js.map

package/lib/profiles/default.d.ts

@@ -0,0 +1,6 @@
+import { TSESLint } from '@typescript-eslint/experimental-utils';
+declare const config: Partial<TSESLint.Linter.ConfigOverride & {
+    ignorePatterns: string[];
+}>;
+export = config;
+//# sourceMappingURL=default.d.ts.map

package/lib/profiles/default.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../../src/profiles/default.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAEjE,QAAA,MAAM,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,GAAG;IAAE,cAAc,EAAE,MAAM,EAAE,CAAA;CAAE,CAkElF,CAAC;AAEF,SAAS,MAAM,CAAC"}

package/lib/profiles/default.js

@@ -0,0 +1,68 @@
+"use strict";
+const config = {
+    extends: ['@rushstack/eslint-config/profile/web-app', '@rushstack/eslint-config/mixins/friendly-locals'],
+    plugins: ['@microsoft/eslint-plugin-spfx'],
+    ignorePatterns: ['*.scss.ts'],
+    overrides: [
+        {
+            files: ['*.ts', '*.tsx'],
+            rules: {
+                'no-extra-boolean-cast': 'off',
+                // ====================================================================
+                // @microsoft/eslint-plugin-spfx
+                // ====================================================================
+                '@microsoft/spfx/import-requires-chunk-name': 'warn',
+                '@microsoft/spfx/no-async-await': 'warn',
+                '@microsoft/spfx/no-require-ensure': 'error',
+                '@microsoft/spfx/pair-react-dom-render-unmount': 'warn'
+            }
+        },
+        {
+            // For unit tests, we can be a little bit less strict.  The settings below revise the
+            // defaults specified in the extended configurations, as well as above.
+            files: [
+                // Test files
+                '*.test.ts',
+                '*.test.tsx',
+                '*.spec.ts',
+                '*.spec.tsx',
+                // Facebook convention
+                '**/__mocks__/*.ts',
+                '**/__mocks__/*.tsx',
+                '**/__tests__/*.ts',
+                '**/__tests__/*.tsx',
+                // Microsoft convention
+                '**/test/*.ts',
+                '**/test/*.tsx'
+            ],
+            rules: {
+                'class-name': 0,
+                'export-name': 0,
+                forin: 0,
+                'label-position': 0,
+                'member-access': 2,
+                'no-arg': 0,
+                'no-console': 0,
+                'no-construct': 0,
+                'no-duplicate-variable': 2,
+                'no-eval': 0,
+                'no-function-expression': 2,
+                'no-internal-module': 2,
+                'no-shadowed-variable': 2,
+                'no-switch-case-fall-through': 2,
+                'no-unnecessary-semicolons': 2,
+                'no-unused-expression': 2,
+                'no-with-statement': 2,
+                semicolon: 2,
+                'trailing-comma': 0,
+                typedef: 0,
+                'typedef-whitespace': 0,
+                'use-named-parameter': 2,
+                'variable-name': 0,
+                whitespace: 0
+            }
+        }
+    ]
+};
+module.exports = config;
+//# sourceMappingURL=default.js.map

package/lib/profiles/react.d.ts

@@ -0,0 +1,6 @@
+import { TSESLint } from '@typescript-eslint/experimental-utils';
+declare const config: Partial<TSESLint.Linter.ConfigOverride & {
+    ignorePatterns: string[];
+}>;
+export = config;
+//# sourceMappingURL=react.d.ts.map

package/lib/profiles/react.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../../src/profiles/react.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAEjE,QAAA,MAAM,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,GAAG;IAAE,cAAc,EAAE,MAAM,EAAE,CAAA;CAAE,CA2ElF,CAAC;AAEF,SAAS,MAAM,CAAC"}

package/lib/profiles/react.js

@@ -0,0 +1,77 @@
+"use strict";
+const config = {
+    extends: [
+        '@rushstack/eslint-config/profile/web-app',
+        '@rushstack/eslint-config/mixins/react',
+        '@rushstack/eslint-config/mixins/friendly-locals'
+    ],
+    plugins: ['@microsoft/eslint-plugin-spfx', 'eslint-plugin-react-hooks'],
+    ignorePatterns: ['*.scss.ts'],
+    overrides: [
+        {
+            files: ['*.ts', '*.tsx'],
+            rules: {
+                'no-extra-boolean-cast': 'off',
+                // ====================================================================
+                // @microsoft/eslint-plugin-spfx
+                // ====================================================================
+                '@microsoft/spfx/import-requires-chunk-name': 'warn',
+                '@microsoft/spfx/no-async-await': 'warn',
+                '@microsoft/spfx/no-require-ensure': 'error',
+                '@microsoft/spfx/pair-react-dom-render-unmount': 'warn',
+                // =====================================================================
+                // eslint-plugin-react-hooks
+                // =====================================================================
+                'react-hooks/rules-of-hooks': 'error',
+                'react-hooks/exhaustive-deps': 'warn'
+            }
+        },
+        {
+            // For unit tests, we can be a little bit less strict.  The settings below revise the
+            // defaults specified in the extended configurations, as well as above.
+            files: [
+                // Test files
+                '*.test.ts',
+                '*.test.tsx',
+                '*.spec.ts',
+                '*.spec.tsx',
+                // Facebook convention
+                '**/__mocks__/*.ts',
+                '**/__mocks__/*.tsx',
+                '**/__tests__/*.ts',
+                '**/__tests__/*.tsx',
+                // Microsoft convention
+                '**/test/*.ts',
+                '**/test/*.tsx'
+            ],
+            rules: {
+                'class-name': 0,
+                'export-name': 0,
+                forin: 0,
+                'label-position': 0,
+                'member-access': 2,
+                'no-arg': 0,
+                'no-console': 0,
+                'no-construct': 0,
+                'no-duplicate-variable': 2,
+                'no-eval': 0,
+                'no-function-expression': 2,
+                'no-internal-module': 2,
+                'no-shadowed-variable': 2,
+                'no-switch-case-fall-through': 2,
+                'no-unnecessary-semicolons': 2,
+                'no-unused-expression': 2,
+                'no-with-statement': 2,
+                semicolon: 2,
+                'trailing-comma': 0,
+                typedef: 0,
+                'typedef-whitespace': 0,
+                'use-named-parameter': 2,
+                'variable-name': 0,
+                whitespace: 0
+            }
+        }
+    ]
+};
+module.exports = config;
+//# sourceMappingURL=react.js.map

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@microsoft/eslint-config-spfx",
+  "version": "1.15.0-rc.0",
+  "description": "ESLint rules for SharePoint Framework solutions",
+  "license": "SEE LICENSE IN \"EULA\" FOLDER",
+  "homepage": "http://aka.ms/spfx",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "scripts": {},
+  "engines": {
+    "node": ">=12.13.0 <13.0.0 || >=14.15.0 <15.0.0 || >=16.13.0 <17.0.0"
+  },
+  "dependencies": {
+    "@typescript-eslint/experimental-utils": "5.20.0"
+  },
+  "peerDependencies": {
+    "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
+  }
+}