@brickflow/lint 0.0.4

package/brick.js

@@ -0,0 +1,5 @@
+import constCase from './rules/const-case.js'
+
+const plugin = { rules: { 'const-case': constCase } }
+
+export default plugin

package/index.cjs

@@ -0,0 +1 @@
+module.exports = require('./index.js').default

package/index.js

@@ -0,0 +1,3 @@
+import { createLintConfig } from './shared.js'
+
+export default createLintConfig()

package/nuxt.cjs

@@ -0,0 +1 @@
+module.exports = require('./nuxt.js').default

package/nuxt.js

@@ -0,0 +1,3 @@
+import { createLintConfig } from './shared.js'
+
+export default createLintConfig({ includeVue: true })

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@brickflow/lint",
+  "version": "0.0.4",
+  "type": "module",
+  "description": "Shared ESLint configs for brickflow workspaces.",
+  "files": [
+    "index.cjs",
+    "index.js",
+    "nuxt.cjs",
+    "nuxt.js",
+    "shared.js",
+    "brick.js",
+    "rules"
+  ],
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs",
+      "default": "./index.js"
+    },
+    "./nuxt": {
+      "import": "./nuxt.js",
+      "require": "./nuxt.cjs",
+      "default": "./nuxt.js"
+    }
+  },
+  "scripts": {
+    "lint": "pnpm run --if-present typecheck && eslint -v && NODE_ENV=deploy eslint --cache .",
+    "lint:fix": "pnpm exec eslint . --fix",
+    "format": "pnpm exec prettier . --ignore-path ../../.prettierignore --write",
+    "format:check": "pnpm exec prettier . --ignore-path ../../.prettierignore --check"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@eslint/js": "^9.39.0",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-perfectionist": "4.15.0",
+    "eslint-plugin-prettier": "5.5.4",
+    "eslint-plugin-promise": "7.2.1",
+    "eslint-plugin-regexp": "2.10.0",
+    "eslint-plugin-vue": "10.5.0",
+    "globals": "^16.4.0",
+    "typescript-eslint": "8.44.1",
+    "vue-eslint-parser": "10.2.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=9",
+    "prettier": ">=3"
+  },
+  "author": "",
+  "license": "ISC"
+}

package/rules/const-case.js

@@ -0,0 +1,58 @@
+const isUpperCase = (name) => name && name === name.toUpperCase()
+
+const isSpecialChars = (name) => name && /^[$_]$/.test(name)
+
+const isCalleeRequire = (init) => {
+  return init && init.callee && init.callee.name === 'require'
+}
+
+const isInitTypeLiteral = (init) => init && init.type === 'Literal'
+
+const isInitTypeNegativeLiteral = (init) =>
+  init && init.type === 'UnaryExpression' && init.operator === '-' && init.argument.type === 'Literal'
+
+const isLiteral = (init) =>
+  isInitTypeLiteral(init) || isInitTypeNegativeLiteral(init) || isInitTypeBinaryExpression(init)
+
+function isInitTypeBinaryExpression(init) {
+  return (
+    init &&
+    init.type === 'BinaryExpression' &&
+    ['*', '+', '-', '/'].includes(init.operator) &&
+    isLiteral(init.left) &&
+    isLiteral(init.right)
+  )
+}
+
+const messages = {
+  lower: 'const/let should be in lower case',
+  upper: 'const should be in upper case',
+}
+
+const rule = {
+  create: ({ report }) => ({
+    VariableDeclaration: (node) => {
+      if (node.kind === 'const') {
+        node.declarations.forEach(({ id: { name }, init }) => {
+          if (!isUpperCase(name) && isLiteral(init)) {
+            report({ message: messages.upper, node })
+          }
+
+          if (isUpperCase(name) && !isLiteral(init) && !isCalleeRequire(init) && !isSpecialChars(name)) {
+            report({ message: messages.lower, node })
+          }
+        })
+      }
+
+      if (node.kind === 'let') {
+        node.declarations.forEach(({ id: { name }, init }) => {
+          if (isUpperCase(name) && !isCalleeRequire(init) && !isSpecialChars(name)) {
+            report({ message: messages.lower, node })
+          }
+        })
+      }
+    },
+  }),
+}
+
+export default rule

package/shared.js

@@ -0,0 +1,333 @@
+import js from '@eslint/js'
+import configPrettier from 'eslint-config-prettier'
+import perfectionist from 'eslint-plugin-perfectionist'
+import prettierRecommended from 'eslint-plugin-prettier/recommended'
+import pluginPromise from 'eslint-plugin-promise'
+import regexp from 'eslint-plugin-regexp'
+import pluginVue from 'eslint-plugin-vue'
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+import vueParser from 'vue-eslint-parser'
+
+import brick from './brick.js'
+
+const warn = process.env.NODE_ENV === 'deploy' ? 'error' : 'warn'
+
+const ignores = [
+  '**/node_modules/**',
+  '**/dist/**',
+  '**/.nuxt/**',
+  '**/.output/**',
+  '**/coverage/**',
+  '**/icon.d.ts',
+  '**/img.d.ts',
+  '.prettierrc.cjs',
+  'eslint.config.cjs',
+]
+
+const baseRules = {
+  '@typescript-eslint/consistent-type-definitions': 'off',
+  '@typescript-eslint/default-param-last': 'error',
+  '@typescript-eslint/explicit-function-return-type': [
+    'error',
+    {
+      allowExpressions: true,
+    },
+  ],
+  '@typescript-eslint/explicit-module-boundary-types': 'error',
+  '@typescript-eslint/no-dynamic-delete': 'off',
+  '@typescript-eslint/no-empty-object-type': ['error', { allowInterfaces: 'always' }],
+  '@typescript-eslint/no-invalid-void-type': 'off',
+  '@typescript-eslint/no-require-imports': 'off',
+  '@typescript-eslint/no-restricted-types': [
+    'error',
+    {
+      types: {
+        object: {
+          message: 'Use Record<string, unknown> instead of object for better type safety.',
+        },
+      },
+    },
+  ],
+  '@typescript-eslint/no-shadow': 'error',
+  '@typescript-eslint/no-unused-expressions': ['error', { allowShortCircuit: true, allowTernary: true }],
+  '@typescript-eslint/no-unused-vars': [
+    warn,
+    {
+      argsIgnorePattern: '^_',
+      ignoreRestSiblings: true,
+      varsIgnorePattern: '^_',
+    },
+  ],
+  '@typescript-eslint/no-use-before-define': [
+    warn,
+    {
+      functions: false,
+    },
+  ],
+  'array-callback-return': 'error',
+  'block-scoped-var': 'error',
+  'brick/const-case': 'off',
+  curly: 'error',
+  'default-case': 'error',
+  'default-case-last': 'error',
+  'default-param-last': 'off',
+  'dot-notation': 'error',
+  eqeqeq: 'error',
+  'logical-assignment-operators': ['error', 'always'],
+  'new-cap': ['error', { newIsCap: true, properties: false }],
+  'no-alert': warn,
+  'no-await-in-loop': 'off',
+  'no-constant-binary-expression': 'error',
+  'no-constructor-return': 'error',
+  'no-debugger': warn,
+  'no-duplicate-imports': 'error',
+  'no-else-return': 'error',
+  'no-empty-function': 'error',
+  'no-empty-static-block': 'error',
+  'no-eq-null': 'error',
+  'no-eval': 'error',
+  'no-extra-semi': 'off',
+  'no-implicit-coercion': 'error',
+  'no-implied-eval': 'error',
+  'no-invalid-this': 'off',
+  'no-lone-blocks': 'error',
+  'no-lonely-if': 'error',
+  'no-loop-func': 'error',
+  'no-multi-assign': 'error',
+  'no-negated-condition': 'error',
+  'no-nested-ternary': 'error',
+  'no-new-func': 'error',
+  'no-new-native-nonconstructor': 'error',
+  'no-new-wrappers': 'error',
+  'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
+  'no-proto': 'error',
+  'no-restricted-syntax': [
+    'error',
+    {
+      message: 'Write function props only with a prefix ^on | ^set.',
+      selector:
+        'CallExpression[callee.name=defineProps] TSPropertySignature[typeAnnotation.typeAnnotation.type=TSFunctionType][key.name!=/^on|^set/]',
+    },
+    {
+      message: 'Use ^set only with function which must return value.',
+      selector:
+        'CallExpression[callee.name=defineProps] TSPropertySignature[typeAnnotation.typeAnnotation.type=TSFunctionType][typeAnnotation.typeAnnotation.returnType.typeAnnotation.type=TSVoidKeyword][key.name=/^set/]',
+    },
+    {
+      message: 'Use ^on only with function who work as Event|Emit.',
+      selector:
+        'CallExpression[callee.name=defineProps] TSPropertySignature[typeAnnotation.typeAnnotation.type=TSFunctionType][typeAnnotation.typeAnnotation.returnType.typeAnnotation.type!=TSVoidKeyword][typeAnnotation.typeAnnotation.returnType.typeAnnotation.type!=TSTypeReference][key.name=/^on/]',
+    },
+    {
+      message: 'Use ^on only with function who work as Event|Emit.',
+      selector:
+        'CallExpression[callee.name=defineProps] TSPropertySignature[typeAnnotation.typeAnnotation.type=TSFunctionType][typeAnnotation.typeAnnotation.returnType.typeAnnotation.type=TSTypeReference][key.name=/^on/] TSTypeParameterInstantiation > :not(TSVoidKeyword)',
+    },
+    {
+      message: 'Use ^set only with function which must return value.',
+      selector:
+        'CallExpression[callee.name=defineProps] TSPropertySignature[typeAnnotation.typeAnnotation.type=TSFunctionType][typeAnnotation.typeAnnotation.returnType.typeAnnotation.type=TSTypeReference][key.name=/^set/] TSTypeParameterInstantiation > TSVoidKeyword',
+    },
+    {
+      message: 'defineEmits is forbidden. Use props or alternative pattern.',
+      selector: "CallExpression[callee.name='defineEmits']",
+    },
+  ],
+  'no-return-assign': 'error',
+  'no-script-url': 'error',
+  'no-self-compare': 'error',
+  'no-undef': 'off',
+  'no-unmodified-loop-condition': 'error',
+  'no-unneeded-ternary': 'error',
+  'no-unreachable-loop': 'error',
+  'no-unused-private-class-members': 'error',
+  'no-unused-vars': 'off',
+  'no-useless-call': 'error',
+  'no-useless-computed-key': 'error',
+  'no-useless-concat': 'error',
+  'no-useless-rename': 'error',
+  'no-var': 'error',
+  'no-void': 'error',
+  'object-shorthand': warn,
+  'one-var': ['error', 'never'],
+  'operator-assignment': ['error'],
+  'perfectionist/sort-vue-attributes': 'off',
+  'prefer-arrow-callback': 'error',
+  'prefer-const': 'error',
+  'prefer-exponentiation-operator': 'error',
+  'prefer-numeric-literals': 'error',
+  'prefer-object-has-own': 'error',
+  'prefer-object-spread': 'error',
+  'prefer-regex-literals': 'error',
+  'prefer-rest-params': 'error',
+  'prefer-spread': 'error',
+  'prefer-template': 'error',
+  'prettier/prettier': warn,
+  'promise/always-return': 'error',
+  'promise/no-nesting': 'error',
+  'promise/no-new-statics': 'error',
+  'promise/no-return-in-finally': 'error',
+  'promise/no-return-wrap': 'error',
+  'promise/param-names': 'error',
+  'promise/prefer-await-to-then': warn,
+  'promise/valid-params': 'error',
+  'require-await': warn,
+  yoda: 'error',
+}
+
+const vueRules = {
+  'vue/attribute-hyphenation': [
+    'error',
+    'never',
+    {
+      ignore: [],
+    },
+  ],
+  'vue/block-lang': [
+    'error',
+    {
+      script: {
+        lang: 'ts',
+      },
+    },
+  ],
+  'vue/component-name-in-template-casing': [
+    'error',
+    'PascalCase',
+    {
+      registeredComponentsOnly: false,
+    },
+  ],
+  'vue/custom-event-name-casing': ['error', 'camelCase'],
+  'vue/define-macros-order': [
+    'error',
+    {
+      order: ['defineOptions', 'defineProps', 'defineSlots', 'defineEmits'],
+    },
+  ],
+  'vue/define-props-declaration': ['error', 'type-based'],
+  'vue/html-button-has-type': [
+    'error',
+    {
+      button: true,
+      reset: true,
+      submit: true,
+    },
+  ],
+  'vue/match-component-import-name': ['error'],
+  'vue/multi-word-component-names': 'off',
+  'vue/next-tick-style': ['error', 'promise'],
+  'vue/no-boolean-default': ['error', 'default-false'],
+  'vue/no-constant-condition': ['error'],
+  'vue/no-duplicate-attr-inheritance': ['error'],
+  'vue/no-empty-component-block': ['error'],
+  'vue/no-restricted-props': [
+    'error',
+    {
+      message: 'Don\'t use word "need" in props',
+      name: '/^need/',
+    },
+  ],
+  'vue/no-restricted-syntax': [
+    'error',
+    {
+      message: 'Use "@" symbol for Event|Emit.',
+      selector: 'VIdentifier[rawName=/^on/]',
+    },
+  ],
+  'vue/no-template-target-blank': [
+    'error',
+    {
+      allowReferrer: false,
+      enforceDynamicLinks: 'always',
+    },
+  ],
+  'vue/no-unused-components': warn,
+  'vue/no-unused-refs': ['error'],
+  'vue/no-unused-vars': warn,
+  'vue/no-useless-v-bind': [
+    'error',
+    {
+      ignoreIncludesComment: false,
+      ignoreStringEscape: false,
+    },
+  ],
+  'vue/no-v-html': 'off',
+  'vue/no-v-text': ['error'],
+  'vue/padding-line-between-blocks': ['error', 'always'],
+  'vue/prefer-true-attribute-shorthand': ['error', 'always'],
+  'vue/require-component-is': 'off',
+  'vue/require-expose': ['error'],
+  'vue/v-for-delimiter-style': ['error'],
+  'vue/v-on-event-hyphenation': [
+    'error',
+    'never',
+    {
+      ignore: [],
+    },
+  ],
+}
+
+const jsRules = {
+  '@typescript-eslint/explicit-function-return-type': 'off',
+  '@typescript-eslint/explicit-module-boundary-types': 'off',
+  '@typescript-eslint/no-var-requires': 'off',
+}
+
+export function createLintConfig({ includeVue = false } = {}) {
+  const languageGlobals = includeVue ? { ...globals.browser, ...globals.node } : { ...globals.node }
+
+  return [
+    js.configs.recommended,
+    ...tseslint.configs.strict,
+    ...(includeVue ? pluginVue.configs['flat/recommended'] : []),
+    perfectionist.configs['recommended-natural'],
+    regexp.configs['flat/recommended'],
+    pluginPromise.configs['flat/recommended'],
+    prettierRecommended,
+    configPrettier,
+    {
+      plugins: {
+        brick,
+      },
+    },
+    {
+      files: ['**/*.{js,mjs,cjs,ts,mts,cts}'],
+      languageOptions: {
+        ecmaVersion: 'latest',
+        globals: languageGlobals,
+        parser: tseslint.parser,
+        sourceType: 'module',
+      },
+      rules: baseRules,
+    },
+    ...(includeVue
+      ? [
+          {
+            files: ['**/*.vue'],
+            languageOptions: {
+              ecmaVersion: 'latest',
+              globals: languageGlobals,
+              parser: vueParser,
+              parserOptions: {
+                parser: tseslint.parser,
+              },
+              sourceType: 'module',
+            },
+            rules: {
+              ...baseRules,
+              ...vueRules,
+            },
+          },
+        ]
+      : []),
+    {
+      files: ['**/*.{js,mjs,cjs}'],
+      rules: jsRules,
+    },
+    {
+      ignores,
+    },
+  ]
+}