@coko/lint 2.0.1 → 3.0.0-alpha.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [3.0.0-alpha.0](https://gitlab.coko.foundation/cokoapps/lint/compare/v2.1.0...v3.0.0-alpha.0) (2025-10-24)
+
+
+### Features
+
+* **eslint:** typescript support and drop airbnb for server ([8eaa3c6](https://gitlab.coko.foundation/cokoapps/lint/commit/8eaa3c68dfd666e86215d80ed94bd0a2081209e1))
+
+## [2.1.0](https://gitlab.coko.foundation/cokoapps/lint/compare/v2.0.1...v2.1.0) (2024-02-26)
+
+
+### Features
+
+* add cli command for lint checks ([c912ce1](https://gitlab.coko.foundation/cokoapps/lint/commit/c912ce1343ccf92668dfa197f01bd6a9f82043a9))
+
+
+### Bug Fixes
+
+* add bin entry to package.json for cli ([3ecb2f5](https://gitlab.coko.foundation/cokoapps/lint/commit/3ecb2f5aa35039ff4e06d54782e3b49a9316ff48))
+
 ### [2.0.1](https://gitlab.coko.foundation/cokoapps/lint/compare/v2.0.0...v2.0.1) (2023-02-23)
 
 

package/README.md

@@ -1 +1 @@
-Documentation can be found [here](https://dev.coko.foundation/?path=/docs/common-libraries-lint--page).
+Documentation can be found [here](https://coko-dev-docs.fly.dev/).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coko/lint",
-  "version": "2.0.1",
+  "version": "3.0.0-alpha.0",
   "description": "Linter configurations and dependencies for coko's projects",
   "keywords": [
     "lint",
@@ -13,7 +13,13 @@
   },
   "license": "MIT",
   "author": "Yannis Barlas",
+  "engines": {
+    "node": "^22.16.0"
+  },
   "main": "src/index.js",
+  "bin": {
+    "coko-lint": "./src/cli.js"
+  },
   "files": [
     "src"
   ],
@@ -29,44 +35,53 @@
     }
   },
   "dependencies": {
-    "@babel/core": "^7.17.7",
-    "@babel/eslint-parser": "^7.17.0",
-    "@babel/preset-react": "^7.16.7",
-    "@commitlint/cli": "^16.2.3",
-    "@commitlint/config-conventional": "^16.2.1",
-    "commitizen": "^4.2.4",
+    "@babel/core": "^7.28.4",
+    "@babel/eslint-parser": "^7.28.4",
+    "@babel/preset-react": "^7.27.1",
+    "@commitlint/cli": "^20.1.0",
+    "@commitlint/config-conventional": "^20.0.0",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.38.0",
+    "commander": "^14.0.1",
+    "commitizen": "^4.3.1",
     "conventional-commit-types": "^3.0.0",
     "cz-conventional-changelog": "^3.3.0",
-    "cz-customizable": "^6.3.0",
-    "eslint": "^8.11.0",
+    "cz-customizable": "^6.9.0",
+    "eslint": "^9.38.0",
     "eslint-config-airbnb": "^19.0.4",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-config-standard": "^16.0.3",
-    "eslint-config-standard-react": "^11.0.1",
-    "eslint-plugin-cypress": "^2.12.1",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jest": "^26.1.1",
-    "eslint-plugin-jsx-a11y": "^6.5.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.0.0",
-    "eslint-plugin-react": "^7.29.4",
-    "eslint-plugin-react-hooks": "^4.3.0",
-    "husky": "^7.0.4",
-    "lint-staged": "^12.3.7",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-config-standard-react": "^13.0.0",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-cypress": "^5.2.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jest": "^29.0.1",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-n": "^17.23.1",
+    "eslint-plugin-promise": "^7.2.1",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.0",
+    "globals": "^16.4.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.6",
     "longest": "^2.0.1",
-    "postcss-scss": "^4.0.3",
-    "prettier": "^2.6.0",
+    "postcss": "^8.5.6",
+    "postcss-scss": "^4.0.9",
+    "prettier": "^3.6.2",
     "right-pad": "^1.0.1",
-    "stylelint": "^14.6.0",
-    "stylelint-config-standard-scss": "^3.0.0",
+    "stylelint": "^16.25.0",
+    "stylelint-config-standard-scss": "^16.0.0",
     "stylelint-config-styled-components": "^0.1.1",
-    "stylelint-order": "^5.0.0",
-    "stylelint-processor-styled-components": "^1.10.0"
+    "stylelint-order": "^7.0.0",
+    "stylelint-processor-styled-components": "^1.10.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.46.2"
   },
   "devDependencies": {
-    "standard-version": "^9.3.2"
+    "standard-version": "^9.5.0"
   },
   "publishConfig": {
     "access": "public"
-  }
-}
+  },
+  "packageManager": "yarn@4.10.3"
+}

package/src/airbnb/variables.mjs

@@ -0,0 +1,26 @@
+// const confusingBrowserGlobals = require('confusing-browser-globals')
+
+export default {
+  rules: {
+    // disallow specific globals
+    'no-restricted-globals': [
+      'error',
+      {
+        name: 'isFinite',
+        message:
+          'Use Number.isFinite instead https://github.com/airbnb/javascript#standard-library--isfinite',
+      },
+      {
+        name: 'isNaN',
+        message:
+          'Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan',
+      },
+    ]
+      .concat
+      // confusingBrowserGlobals.map(g => ({
+      //   name: g,
+      //   message: `Use window.${g} instead. https://github.com/facebook/create-react-app/blob/HEAD/packages/confusing-browser-globals/README.md`,
+      // })),
+      (),
+  },
+}

package/src/cli.js

@@ -0,0 +1,131 @@
+#!/usr/bin/env node
+
+/* eslint-disable no-console */
+
+const { program } = require('commander')
+const { execSync } = require('child_process')
+
+const pkg = require('../package.json')
+
+const ESLINT = 'ESLint'
+const STYLELINT = 'Stylelint'
+const PRETTIER = 'Prettier'
+const filler = '>>>> '
+
+// #region actions
+const printVersion = () => {
+  console.log(`Coko lint version: ${program.version()}`)
+}
+
+const runCommand = (name, command, isSubprocess) => {
+  console.log(`\n${filler}Running ${name}...`)
+
+  try {
+    execSync(command, { stdio: 'inherit' })
+  } catch (error) {
+    console.error(`Error running ${name}: ${error.message}`)
+
+    if (isSubprocess) {
+      throw new Error()
+    } else {
+      process.exit(1)
+    }
+  }
+}
+
+const runSubprocess = (fn, name, skip) => {
+  try {
+    if (skip) {
+      console.log(`\n${filler}Skipping ${name}...`)
+      return
+    }
+
+    fn(true)
+  } catch {
+    throw new Error()
+  }
+}
+
+const runESLint = isSubprocess => {
+  const command = `npx eslint ${process.cwd()}`
+  runCommand(ESLINT, command, isSubprocess)
+}
+
+const runStylelint = isSubprocess => {
+  const command = `npx stylelint "${process.cwd()}/**/*.js"`
+  runCommand(STYLELINT, command, isSubprocess)
+}
+
+const runPrettier = isSubprocess => {
+  const command = `npx prettier --check ${process.cwd()}`
+  runCommand(PRETTIER, command, isSubprocess)
+}
+
+const runAll = (options = {}) => {
+  let hasErrors = false
+
+  const processes = [
+    [runESLint, ESLINT, options.skipEslint],
+    [runStylelint, STYLELINT, options.skipStylelint],
+    [runPrettier, PRETTIER, options.skipPrettier],
+  ]
+
+  /* eslint-disable-next-line no-restricted-syntax */
+  for (const process of processes) {
+    try {
+      runSubprocess(...process)
+    } catch {
+      hasErrors = true
+    }
+  }
+
+  if (hasErrors) {
+    console.error('\nError: Linting checks did not pass!')
+    process.exit(1)
+  }
+
+  console.log(`\nLinting checks successfully passed`)
+}
+// #endregion actions
+
+program
+  .name('coko-lint')
+  .version(pkg.version)
+  .description("Coko's cli tool for running linters")
+
+program
+  .command('eslint')
+  .description('Run eslint command')
+  .action(() => {
+    printVersion()
+    runESLint()
+  })
+
+program
+  .command('stylelint')
+  .description('Run stylelint command')
+  .action(() => {
+    printVersion()
+    runStylelint()
+  })
+
+program
+  .command('prettier')
+  .description('Run prettier command')
+  .action(() => {
+    printVersion()
+    runPrettier()
+  })
+
+program
+  .command('run')
+  .description('Run all commands (eslint, stylelint, prettier)')
+  .option('--skip-eslint', 'Skip eslint')
+  .option('--skip-stylelint', 'Skip stylelint')
+  .option('--skip-prettier', 'Skip prettier')
+  .action(options => {
+    printVersion()
+    runAll(options)
+  })
+
+program.parse(process.argv)

package/src/eslint.mjs

@@ -0,0 +1,260 @@
+// import path from 'path'
+
+import { defineConfig, globalIgnores } from 'eslint/config'
+import js from '@eslint/js'
+// import { FlatCompat } from '@eslint/eslintrc'
+
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+// import babelParser from '@babel/eslint-parser'
+
+import nodePlugin from 'eslint-plugin-n'
+import importPlugin from 'eslint-plugin-import'
+// import jest from 'eslint-plugin-jest'
+// import cypressPlugin from 'eslint-plugin-cypress'
+
+// const __filename = fileURLToPath(import.meta.url)
+// const __dirname = path.dirname(__filename)
+
+// const compat = new FlatCompat({
+//   // baseDirectory: __dirname,
+//   resolvePluginsRelativeTo: import.meta.url,
+//   // recommendedConfig: js.configs.recommended,
+//   // allConfig: js.configs.all,
+// })
+
+/**
+ * TO DO
+ *
+ * explicit rules from old config
+ * jest
+ * cypress
+ *
+ * => client
+ * no console
+ * jsx a11y
+ * airbnb react
+ * react recommended
+ * react hooks
+ * confusing-browser-globals
+ *
+ * => drop dependencies
+ * airbnb
+ * @eslint/eslintrc (if not using flat compat)
+ * babel eslint parser
+ *
+ */
+
+const commonRules = {
+  'array-callback-return': 'error',
+  'block-scoped-var': 'error',
+  camelcase: ['error', { properties: 'never' }],
+  'class-methods-use-this': 'error',
+  'consistent-return': 'error',
+  'default-case-last': 'error',
+  'default-param-last': 'error',
+  'dot-notation': 'error',
+  eqeqeq: ['error', 'always', { null: 'ignore' }],
+  'new-cap': 'error',
+  'no-alert': 'error',
+  'no-await-in-loop': 'error',
+  'no-bitwise': 'error',
+  'no-caller': 'error',
+  'no-constructor-return': 'error',
+  'no-else-return': ['error', { allowElseIf: false }],
+  'no-eval': 'error',
+  'no-extend-native': 'error',
+  'no-extra-bind': 'error',
+  'no-extra-label': 'error',
+  'no-implied-eval': 'error',
+  'no-labels': 'error',
+  'no-lone-blocks': 'error',
+  'no-loop-func': 'error',
+  'no-multi-assign': 'error',
+  'no-multi-str': 'error',
+  'no-nested-ternary': 'error',
+  'no-new': 'error',
+  'no-new-func': 'error',
+  'no-new-wrappers': 'error',
+  'no-plusplus': 'error',
+  'no-promise-executor-return': 'error',
+  'no-proto': 'error',
+  'no-return-assign': ['error', 'always'],
+  'no-script-url': 'error',
+  'no-self-compare': 'error',
+  'no-sequences': 'error',
+  'no-shadow': 'error',
+  'no-template-curly-in-string': 'warn',
+  'no-throw-literal': 'error',
+  'no-undef-init': 'warn',
+  'no-undefined': 'error',
+  'no-unneeded-ternary': ['error', { defaultAssignment: false }],
+  'no-unused-expressions': 'error',
+  'no-useless-computed-key': 'error',
+  'no-useless-constructor': 'error',
+  'no-useless-return': 'error',
+  'no-var': 'error',
+  'no-void': 'error',
+  'prefer-const': ['error', { ignoreReadBeforeAssign: true }],
+  'prefer-promise-reject-errors': ['error', { allowEmptyReject: true }],
+  'prefer-template': 'error',
+  radix: 'error',
+  semi: 'off',
+  yoda: 'error',
+
+  // import
+  'import/first': 'error',
+  'import/extensions': [
+    'error',
+    'ignorePackages',
+    {
+      js: 'never',
+      ts: 'never',
+    },
+  ],
+  'import/no-absolute-path': 'error',
+  'import/no-cycle': ['error', { maxDepth: '∞' }],
+  'import/no-extraneous-dependencies': [
+    'error',
+    {
+      devDependencies: [
+        // storybook
+        '.storybook/*',
+        '**/stories/**/*.js',
+
+        // tests
+        'cypress/**',
+        '**/*.spec.js',
+        '**/*.test.js',
+        '**/__tests__/**/*',
+
+        // webpack
+        'webpack/**',
+
+        // configs
+        '.commitlintrc.js',
+        '.cz-config.js',
+        '.jest.config.js',
+        '.lintstagedrc.js',
+        '.prettierrc.js',
+        '.stylelintrc.js',
+        'eslint.config.js',
+        'eslint.config.mjs',
+
+        // other
+        'dev/**',
+      ],
+    },
+  ],
+  'import/no-import-module-exports': 'error',
+  'import/no-useless-path-segments': ['error', { commonjs: true }],
+  'import/order': ['error', { groups: [['builtin', 'external', 'internal']] }],
+}
+
+const server = [
+  js.configs.recommended,
+  importPlugin.flatConfigs.recommended,
+
+  {
+    files: ['**/*.{js,mjs,ts}'],
+    languageOptions: {
+      globals: { ...globals.node },
+    },
+    plugins: {
+      n: nodePlugin,
+    },
+    settings: {
+      'import/resolver': {
+        typescript: {
+          alwaysTryTypes: true,
+        },
+      },
+      n: { tryExtensions: ['.js', '.ts'] },
+    },
+    rules: {
+      ...commonRules,
+      'no-console': 'error',
+      'import/no-unresolved': ['error', { commonjs: true }],
+    },
+  },
+
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      sourceType: 'commonjs',
+    },
+    rules: {
+      ...nodePlugin.configs['flat/recommended-script'].rules,
+    },
+  },
+
+  {
+    files: ['**/*.mjs', '**/*.ts'],
+    rules: {
+      'no-restricted-globals': [
+        'error',
+        {
+          name: '__dirname',
+          message:
+            'Do not use __dirname; use import.meta.url or process.cwd().',
+        },
+        {
+          name: '__filename',
+          message:
+            'Do not use __filename in ES modules or TypeScript; use import.meta.url or path.resolve() instead.',
+        },
+        {
+          name: 'isFinite',
+          message:
+            'Use Number.isFinite instead https://github.com/airbnb/javascript#standard-library--isfinite',
+        },
+        {
+          name: 'isNaN',
+          message:
+            'Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan',
+        },
+      ],
+    },
+  },
+
+  {
+    files: ['**/*.mjs'],
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+    },
+    rules: {
+      ...nodePlugin.configs['flat/recommended-module'].rules,
+    },
+  },
+
+  {
+    files: ['**/*.ts'],
+    languageOptions: {
+      parser: tseslint.parser,
+      sourceType: 'module',
+    },
+    plugins: {
+      '@typescript-eslint': tseslint.plugin,
+    },
+    rules: {
+      ...tseslint.configs.recommended.rules,
+      '@typescript-eslint/explicit-function-return-type': 'error',
+    },
+  },
+
+  globalIgnores([
+    '**/_build',
+    '**/dist',
+    '!**/.storybook',
+    '!**/.commitlintrc.js',
+    '!**/.cz-config.js',
+    '!**/.jest.config.js',
+    '!**/.lintstagedrc.js',
+    '!**/.prettierrc.js',
+    '!**/.stylelintrc.js',
+    '**/node_modules',
+  ]),
+]
+
+export { defineConfig as defineEslintConfig, server as serverEslintConfig }

package/src/index.mjs

@@ -0,0 +1,14 @@
+import commitizen from './commitizen'
+import { defineEslintConfig, serverEslintConfig } from './eslint.mjs'
+import prettier from './prettier'
+import stylelint from './stylelint'
+import lintstaged from './lintstaged'
+
+export {
+  defineEslintConfig,
+  serverEslintConfig,
+  stylelint,
+  prettier,
+  commitizen,
+  lintstaged,
+}

package/src/index.js

@@ -1,13 +0,0 @@
-const commitizen = require('./commitizen')
-const eslint = require('./eslint')
-const prettier = require('./prettier')
-const stylelint = require('./stylelint')
-const lintstaged = require('./lintstaged')
-
-module.exports = {
-  commitizen,
-  eslint,
-  prettier,
-  stylelint,
-  lintstaged,
-}