Merge pull request #7 from daveseah/dev-ds/eslint-config

Prettier/ESLint Configuration Updates

Author: daveseah

.eslintrc-rules.js

@@ -0,0 +1,67 @@
+/*///////////////////////////////// ABOUT \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\
+
+  These are the specific overrides we use. It's imported in our
+  .eslintrc.js file
+
+\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ * /////////////////////////////////////*/
+
+const LINT_LEVEL = process.env.GS_LINT_LEVEL || 1;
+
+/// RULE OVERRIDES ////////////////////////////////////////////////////////////
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+const URSYS_STYLE = {
+  /* ursys style overrides */
+  'spaced-comment': 'off',
+  'camelcase': 'off',
+  'comma-dangle': ['error', 'never'],
+  'no-underscore-dangle': 'off',
+  'lines-between-class-members': 'off',
+  'no-bitwise': 'off',
+  'import/prefer-default-export': 'off',
+  'object-shorthand': 'off'
+};
+/* allow classroom debugging by researchers */
+const CLASSROOM = {
+  'no-console': 'off',
+  'no-debugger': 'warn',
+  'no-alert': 'warn',
+  'no-restricted-syntax': 'off'
+};
+/* turn off typescript recommendations */
+const HELP_TSJS = {
+  'no-undef': 'off', // TS handles this better; works with global types
+  'no-unused-vars': 'off',
+  'no-shadow': 'off',
+  'no-param-reassign': 'off',
+  'object-curly-newline': 'off',
+  'react/jsx-props-no-spreading': 'off',
+  'arrow-body-style': 'off',
+  'no-plusplus': 'off',
+  'prefer-const': 'off',
+  'prefer-destructuring': 'off',
+  'class-methods-use-this': 'off',
+  'jsx-a11y/label-has-associated-control': 'off'
+};
+/* disable rules for material-ui sanity */
+const YUCK_MUI = {
+  'react/forbid-prop-types': 'off',
+  'react/prop-types': 'off'
+};
+/* disable prettier conflicts manually */
+const YUCK_PRETTIER = {
+  'arrow-parens': 'off'
+};
+/* these are our specific overrides of the recommended rules */
+const RULES = {
+  ...URSYS_STYLE,
+  ...CLASSROOM,
+  ...HELP_TSJS,
+  ...YUCK_MUI,
+  ...YUCK_PRETTIER
+};
+
+/// EXPORTS ///////////////////////////////////////////////////////////////////
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+module.exports = {
+  RULES
+};

.eslintrc.js

@@ -0,0 +1,54 @@
+/*///////////////////////////////// ABOUT \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\
+
+  ESLINT CONFIGURATION for NETCREATE ITEST (2023)
+
+\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ * /////////////////////////////////////*/
+
+const { RULES } = require('./.eslintrc-rules');
+
+/// BASE CONFIGURATION ////////////////////////////////////////////////////////
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+const config = {
+  /*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*:
+    We want to support both node-style 'require' and es6 module 'import'.
+  :*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
+  env: {
+    browser: true,
+    es6: true,
+    node: true
+  },
+  parserOptions: {
+    'ecmaVersion': 2021,
+    'sourceType': 'module'
+  },
+  /*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*:
+    Plugins are packages that rules and sets of rules, but could also be
+    something else (e.g. parser) that ESLINT can make use of.
+    See: eslint.org/docs/user-guide/configuring#use-a-plugin
+  :*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
+  plugins: ['react'],
+  extends: [
+    'eslint:recommended', // standard recommendations
+    'plugin:react/recommended', // handle jsx syntax
+    'prettier' // prettier overrides
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly'
+  },
+  settings: {
+    'react': {
+      'version': 'detect'
+    }
+  },
+  /*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*:
+    The "rules" field can override what was set in the "extends" field.
+    I am turning off the rules that I find annoying or trigger false warnings
+    in some code structures.
+  :*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
+  rules: RULES
+};
+
+/// EXPORTS ///////////////////////////////////////////////////////////////////
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+module.exports = config;

.eslintrc.json

@@ -8,7 +8,7 @@
 
 module.exports = {
   semi: true,
-  printWidth: 90,
+  printWidth: 86,
   singleQuote: true,
   quoteProps: 'preserve',
   arrowParens: 'avoid',