eslint-plugin-gamut 3.0.3-alpha.c94951.0 → 3.0.3-alpha.d2732e.0

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
-eslint-plugin-gamut:build: cache hit, replaying output 16aa82dddbe273b0
+eslint-plugin-gamut:build: cache hit, replaying output d0dfd7ca4be0c9cf
 eslint-plugin-gamut:build: $ yarn build:clean && yarn build:compile
 eslint-plugin-gamut:build: $ rm -rf dist
 eslint-plugin-gamut:build: $ tsc

package/CHANGELOG.md

@@ -3,6 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-### 3.0.3-alpha.c94951.0 (2022-02-04)
+### 3.0.3-alpha.d2732e.0 (2022-02-04)
 
 **Note:** Version bump only for package eslint-plugin-gamut

package/README.md

@@ -1,18 +1,21 @@
-# `gamut-tests`
+# `eslint-plugin-gamut`
 
-Shared component test setup for Gamut applications. ✨
-
-A wrapper around [`component-test-setup`](https://github.com/Codecademy/component-test-setup) that wraps the node with an `@emotion/react`+`gamut-styles` `<ThemeProvider theme={theme}>`.
-Use this instead of `component-test-setup` to test Gamut components in Gamut apps!
+Recommended eslint plugin for Gamut applications. ✨
 
 ## Usage
 
-The API is functionally the same `component-test-setup`:
-
 ```tsx
-import { setupRtl } from '@codecademy/gamut-tests';
+// eslintrc.js
+
+module.exports = {
+  root: true,
 
-const renderView = setupRtl(MyComponent, { prop: true });
+  plugins: ['eslint-plugin-gamut'],
 
-const { view } = renderView();
+  rules: {
+    'gamut/prefer-themed': 'error',
+    'gamut/no-css-standalone': 'error',
+    'gamut/import-paths': 'error',
+  },
+};
 ```

package/dist/prefer-themed.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const experimental_utils_1 = require("@typescript-eslint/experimental-utils");
 const createRule_1 = require("./createRule");
+const utils_1 = require("./utils");
 exports.default = (0, createRule_1.createRule)({
     // @to-do: create helper function to get node
     create(context) {
@@ -14,29 +15,13 @@ exports.default = (0, createRule_1.createRule)({
                     const arrowFuncExpression = node.quasi.expressions[0];
                     if (arrowFuncExpression?.type !== experimental_utils_1.AST_NODE_TYPES.ArrowFunctionExpression)
                         return;
-                    const argObject = arrowFuncExpression.params[0];
-                    if (argObject?.type !== experimental_utils_1.AST_NODE_TYPES.ObjectPattern)
+                    if (!(0, utils_1.isNamedVariableTheme)(arrowFuncExpression))
                         return;
-                    const argumentVariable = argObject.properties[0].value;
-                    if (argumentVariable?.type !== experimental_utils_1.AST_NODE_TYPES.Identifier)
-                        return;
-                    const namedArgumentVariable = argumentVariable.name;
-                    if (expressionVariable === 'styled' &&
-                        namedArgumentVariable === 'theme') {
-                        // TURN INTO UTILITY FUNCTION
-                        if (arrowFuncExpression.body.type !== experimental_utils_1.AST_NODE_TYPES.MemberExpression)
-                            return;
-                        if (arrowFuncExpression.body.object.type !==
-                            experimental_utils_1.AST_NODE_TYPES.MemberExpression)
-                            return;
-                        if (arrowFuncExpression.body.property.type !==
-                            experimental_utils_1.AST_NODE_TYPES.Identifier)
-                            return;
-                        if (arrowFuncExpression.body.object.property.type !==
-                            experimental_utils_1.AST_NODE_TYPES.Identifier)
+                    if (expressionVariable === 'styled') {
+                        const { themeValueKey, themeCategory } = (0, utils_1.checkArrowFuncBodyTypesAndReturnThemeVars)(arrowFuncExpression) ||
+                            {};
+                        if (!themeValueKey)
                             return;
-                        const themeValueKey = arrowFuncExpression.body.property.name;
-                        const themeCategory = arrowFuncExpression.body.object.property.name;
                         context.report({
                             fix: (fixer) => {
                                 return fixer.replaceText(arrowFuncExpression, `themed('${themeCategory}.${themeValueKey}')`);
@@ -57,7 +42,7 @@ exports.default = (0, createRule_1.createRule)({
         },
         fixable: 'code',
         messages: {
-            preferThemed: 'Use the themed(url) style utility instead.',
+            preferThemed: 'Use the themed style utility instead from gamut-styles instead.',
         },
         type: 'suggestion',
         schema: [],

package/dist/prefer-themed.js.map

@@ -1 +1 @@
-{"version":3,"file":"prefer-themed.js","sourceRoot":"","sources":["../src/prefer-themed.ts"],"names":[],"mappings":";;AAAA,8EAAuE;AAEvE,6CAA0C;AAE1C,kBAAe,IAAA,uBAAU,EAAC;IACxB,6CAA6C;IAE7C,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,wBAAwB,CAAC,IAAI;gBAC3B,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,mCAAc,CAAC,gBAAgB,EAAE;oBACrD,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY;wBAAE,OAAO;oBAClD,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;oBAChD,MAAM,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;oBAEtD,IACE,mBAAmB,EAAE,IAAI,KAAK,mCAAc,CAAC,uBAAuB;wBAEpE,OAAO;oBACT,MAAM,SAAS,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;oBAEhD,IAAI,SAAS,EAAE,IAAI,KAAK,mCAAc,CAAC,aAAa;wBAAE,OAAO;oBAC7D,MAAM,gBAAgB,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;oBAEvD,IAAI,gBAAgB,EAAE,IAAI,KAAK,mCAAc,CAAC,UAAU;wBAAE,OAAO;oBACjE,MAAM,qBAAqB,GAAG,gBAAgB,CAAC,IAAI,CAAC;oBAEpD,IACE,kBAAkB,KAAK,QAAQ;wBAC/B,qBAAqB,KAAK,OAAO,EACjC;wBACA,6BAA6B;wBAC7B,IACE,mBAAmB,CAAC,IAAI,CAAC,IAAI,KAAK,mCAAc,CAAC,gBAAgB;4BAEjE,OAAO;wBACT,IACE,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI;4BACpC,mCAAc,CAAC,gBAAgB;4BAE/B,OAAO;wBACT,IACE,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI;4BACtC,mCAAc,CAAC,UAAU;4BAEzB,OAAO;wBACT,IACE,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI;4BAC7C,mCAAc,CAAC,UAAU;4BAEzB,OAAO;wBACT,MAAM,aAAa,GAAG,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;wBAC7D,MAAM,aAAa,GAAG,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;wBAEpE,OAAO,CAAC,MAAM,CAAC;4BACb,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE;gCACb,OAAO,KAAK,CAAC,WAAW,CACtB,mBAAmB,EACnB,WAAW,aAAa,IAAI,aAAa,IAAI,CAC9C,CAAC;4BACJ,CAAC;4BACD,SAAS,EAAE,cAAc;4BACzB,IAAI;yBACL,CAAC,CAAC;qBACJ;iBACF;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IACD,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,WAAW,EAAE,6BAA6B;YAC1C,WAAW,EAAE,OAAO;SACrB;QACD,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE;YACR,YAAY,EAAE,4CAA4C;SAC3D;QACD,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,EAAE;KACX;IACD,IAAI,EAAE,eAAe;CACtB,CAAC,CAAC"}
+{"version":3,"file":"prefer-themed.js","sourceRoot":"","sources":["../src/prefer-themed.ts"],"names":[],"mappings":";;AAAA,8EAAuE;AAEvE,6CAA0C;AAC1C,mCAGiB;AAEjB,kBAAe,IAAA,uBAAU,EAAC;IACxB,6CAA6C;IAE7C,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,wBAAwB,CAAC,IAAI;gBAC3B,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,mCAAc,CAAC,gBAAgB,EAAE;oBACrD,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY;wBAAE,OAAO;oBAClD,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;oBAChD,MAAM,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;oBAEtD,IACE,mBAAmB,EAAE,IAAI,KAAK,mCAAc,CAAC,uBAAuB;wBAEpE,OAAO;oBAET,IAAI,CAAC,IAAA,4BAAoB,EAAC,mBAAmB,CAAC;wBAAE,OAAO;oBAEvD,IAAI,kBAAkB,KAAK,QAAQ,EAAE;wBACnC,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,GACpC,IAAA,iDAAyC,EAAC,mBAAmB,CAAC;4BAC9D,EAAE,CAAC;wBAEL,IAAI,CAAC,aAAa;4BAAE,OAAO;wBAE3B,OAAO,CAAC,MAAM,CAAC;4BACb,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE;gCACb,OAAO,KAAK,CAAC,WAAW,CACtB,mBAAmB,EACnB,WAAW,aAAa,IAAI,aAAa,IAAI,CAC9C,CAAC;4BACJ,CAAC;4BACD,SAAS,EAAE,cAAc;4BACzB,IAAI;yBACL,CAAC,CAAC;qBACJ;iBACF;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IACD,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,WAAW,EAAE,6BAA6B;YAC1C,WAAW,EAAE,OAAO;SACrB;QACD,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE;YACR,YAAY,EACV,iEAAiE;SACpE;QACD,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,EAAE;KACX;IACD,IAAI,EAAE,eAAe;CACtB,CAAC,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,6 @@
+import { TSESTree } from '@typescript-eslint/experimental-utils';
+export declare const isNamedVariableTheme: (arrowExpression: TSESTree.ArrowFunctionExpression) => boolean;
+export declare const checkArrowFuncBodyTypesAndReturnThemeVars: (arrowFuncExpression: TSESTree.ArrowFunctionExpression) => false | {
+    themeValueKey: string;
+    themeCategory: string;
+};

package/dist/utils.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkArrowFuncBodyTypesAndReturnThemeVars = exports.isNamedVariableTheme = void 0;
+const experimental_utils_1 = require("@typescript-eslint/experimental-utils");
+const isNamedVariableTheme = (arrowExpression) => {
+    const argObject = arrowExpression.params[0];
+    if (argObject?.type !== experimental_utils_1.AST_NODE_TYPES.ObjectPattern)
+        return false;
+    const argumentVariable = argObject.properties[0].value;
+    if (argumentVariable?.type !== experimental_utils_1.AST_NODE_TYPES.Identifier)
+        return false;
+    const namedArgumentVariable = argumentVariable.name;
+    return namedArgumentVariable === 'theme';
+};
+exports.isNamedVariableTheme = isNamedVariableTheme;
+const checkArrowFuncBodyTypesAndReturnThemeVars = (arrowFuncExpression) => {
+    if (arrowFuncExpression.body.type !== experimental_utils_1.AST_NODE_TYPES.MemberExpression ||
+        arrowFuncExpression.body.object.type !== experimental_utils_1.AST_NODE_TYPES.MemberExpression ||
+        arrowFuncExpression.body.property.type !== experimental_utils_1.AST_NODE_TYPES.Identifier ||
+        arrowFuncExpression.body.object.property.type !== experimental_utils_1.AST_NODE_TYPES.Identifier)
+        return false;
+    const themeValueKey = arrowFuncExpression.body.property.name;
+    const themeCategory = arrowFuncExpression.body.object.property.name;
+    return { themeValueKey, themeCategory };
+};
+exports.checkArrowFuncBodyTypesAndReturnThemeVars = checkArrowFuncBodyTypesAndReturnThemeVars;
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,8EAG+C;AAExC,MAAM,oBAAoB,GAAG,CAClC,eAAiD,EACjD,EAAE;IACF,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAE5C,IAAI,SAAS,EAAE,IAAI,KAAK,mCAAc,CAAC,aAAa;QAAE,OAAO,KAAK,CAAC;IACnE,MAAM,gBAAgB,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAEvD,IAAI,gBAAgB,EAAE,IAAI,KAAK,mCAAc,CAAC,UAAU;QAAE,OAAO,KAAK,CAAC;IACvE,MAAM,qBAAqB,GAAG,gBAAgB,CAAC,IAAI,CAAC;IAEpD,OAAO,qBAAqB,KAAK,OAAO,CAAC;AAC3C,CAAC,CAAC;AAZW,QAAA,oBAAoB,wBAY/B;AAEK,MAAM,yCAAyC,GAAG,CACvD,mBAAqD,EACrD,EAAE;IACF,IACE,mBAAmB,CAAC,IAAI,CAAC,IAAI,KAAK,mCAAc,CAAC,gBAAgB;QACjE,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,mCAAc,CAAC,gBAAgB;QACxE,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,mCAAc,CAAC,UAAU;QACpE,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,mCAAc,CAAC,UAAU;QAE3E,OAAO,KAAK,CAAC;IAEf,MAAM,aAAa,GAAG,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC7D,MAAM,aAAa,GAAG,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;IAEpE,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC;AAC1C,CAAC,CAAC;AAfW,QAAA,yCAAyC,6CAepD"}

package/jest.config.js

@@ -1,4 +1,5 @@
 module.exports = require('../../jest.config.base')('eslint-plugin-gamut', {
+  testEnvironment: 'node',
   setupFiles: [],
   setupFilesAfterEnv: [],
 });

package/package.json

@@ -8,7 +8,7 @@
     "gamut-styles"
   ],
   "name": "eslint-plugin-gamut",
-  "version": "3.0.3-alpha.c94951.0",
+  "version": "3.0.3-alpha.d2732e.0",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "dist/index.js",
@@ -35,5 +35,5 @@
   "devDependencies": {
     "@types/eslint": "^8.2.1"
   },
-  "gitHead": "e9d19577b1b1df1ce7113d65b7ab19379608a897"
+  "gitHead": "ea159a99d55de6ee7592f00eb68ada77c2a25eee"
 }