@diplodoc/lint 1.0.0

package/.github/workflows/release.yml

@@ -0,0 +1,21 @@
+on:
+  push:
+    branches: [master]
+
+name: release
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: gravity-ui/release-action@v1
+        with:
+          github-token: ${{ secrets.YC_UI_BOT_GITHUB_TOKEN }}
+          npm-token: ${{ secrets.ROBOT_DATAUI_NPM_TOKEN }}
+          node-version: 18
+          default-branch: ${{ github.ref_name != 'master' && github.ref_name || null }}
+          npm-dist-tag: ${{ github.ref_name != 'master' && 'untagged' || 'latest' }}

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 1.0.0 (2024-08-10)
+
+
+### Features
+
+* Split init and update phase ([b0e6a87](https://github.com/diplodoc-platform/lint/commit/b0e6a872624fe8c3af56ed815dee5224b7da5434))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Yandex LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,33 @@
+[![NPM version](https://img.shields.io/npm/v/@diplodoc/lint.svg?style=flat)](https://www.npmjs.org/package/@diplodoc/lint)
+
+# @diplodoc/lint
+
+Diplodoc platform internal utility set for linting
+
+
+## Install
+
+```
+npm install --save-dev @diplodoc/lint
+```
+
+## Usage
+
+Add initial configuration
+
+```sh
+npx @diplodoc/lint install
+git add --all && git commit -m 'chore: init lint'
+```
+
+Run lint
+
+```sh
+npm run lint
+```
+
+Run lint in fix mode
+
+```sh
+npm run lint:fix
+```

package/bin/lint

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+set -e
+
+BINDIR=$(dirname $0)
+SRCDIR=$(dirname $(dirname $(node -pe "require('fs').realpathSync('$0')")))
+
+while (( $# )); do
+    case "$1" in
+        --fix ) :
+            FIX=1
+            ;;
+        install|init ) :
+            INIT=1
+            ;;
+        update ) :
+            UPDATE=1
+            ;;
+    esac
+    shift
+done
+
+if [[ -n $INIT || -n $UPDATE]]; then
+  echo "[@diplodoc/lint] Add initial lint configs"
+  cp -r "$SRCDIR/scaffolding/" .
+
+  echo "[@diplodoc/lint] Extend .ignore configuration"
+  node "$SRCDIR/scripts/modify-ignore.js"
+fi
+
+if [[ -n $INIT ]]; then
+  echo "[@diplodoc/lint] Extend package.json configuration"
+  node "$SRCDIR/scripts/modify-package.js"
+
+  $BINDIR/husky install
+
+  exit 0
+fi
+
+if [[ -n $FIX ]]; then
+  echo "Run linters in fix mode"
+
+  $BINDIR/eslint '**/*.{js,jsx,ts,tsx}' --fix
+  $BINDIR/prettier --write 'src/**/*.{js,jsx,ts,tsx}'
+  $BINDIR/stylelint src/**/*.scss --fix
+
+  exit 0
+fi
+
+echo "Run linters"
+
+$BINDIR/eslint '**/*.{js,jsx,ts,tsx}'
+$BINDIR/prettier --check 'src/**/*.{js,jsx,ts,tsx}'
+$BINDIR/stylelint src/**/*.scss
+
+

package/eslint-client-config.js

@@ -0,0 +1,7 @@
+module.exports = {
+    root: true,
+    extends: [
+        '@gravity-ui/eslint-config/client',
+        './eslint-common-config.js',
+    ],
+};

package/eslint-common-config.js

@@ -0,0 +1,36 @@
+module.exports = {
+    root: true,
+    extends: [
+        '@gravity-ui/eslint-config',
+        process.env.npm_command && '@gravity-ui/eslint-config/prettier',
+    ].filter(Boolean),
+    parserOptions: {
+        project: ["./tsconfig.json"]
+    },
+    rules: {
+        'callback-return': 'off',
+        'consistent-return': 'off',
+        'no-implicit-globals': 'off',
+        'no-param-reassign': 'off',
+        '@typescript-eslint/no-shadow': 'off',
+        'import/no-extraneous-dependencies': 'error',
+        'import/order': [
+            'error',
+            {
+                alphabetize: {
+                    order: 'ignore',
+                    orderImportKind: 'asc'
+                },
+                'newlines-between': 'always',
+                groups: ['type', ['builtin', 'external'], 'internal', 'parent', 'sibling', 'index'],
+                warnOnUnassignedImports: true,
+                pathGroups: [
+                    {
+                        pattern: '*.s?css$',
+                        group: 'index',
+                    },
+                ],
+            },
+        ],
+    },
+};

package/eslint-node-config.js

@@ -0,0 +1,9 @@
+module.exports = {
+    root: true,
+    extends: [
+        './eslint-common-config.js',
+    ],
+    env: {
+        node: true,
+    },
+};

package/eslint-prettier-config.js

@@ -0,0 +1,3 @@
+module.exports = {
+    'extends': ['plugin:prettier/recommended'],
+};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@diplodoc/lint",
+  "version": "1.0.0",
+  "description": "Diplodoc platform internal utility set for linting",
+  "bin": {
+    "lint": "./bin/lint"
+  },
+  "scripts": {
+    "test": "exit 0"
+  },
+  "exports": {
+    "./eslint-config": "./eslint-common-config.js",
+    "./eslint-config/client": "./eslint-client-config.js",
+    "./eslint-config/node": "./eslint-node-config.js",
+    "./eslint-config/prettier": "./eslint-client-config.js",
+    "./prettier-config": "./prettier-common-config.js",
+    "./stylelint-config": "./stylelint-common-config.js",
+    "./lintstaged-config": "./stylelint-common-config.js"
+  },
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@gravity-ui/eslint-config": "^3.2.0",
+    "@gravity-ui/prettier-config": "^1.1.0",
+    "@gravity-ui/stylelint-config": "^4.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.0.1",
+    "@typescript-eslint/parser": "^8.0.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-security": "^3.0.1",
+    "husky": "^9.1.4",
+    "lint-staged": "^15.2.8",
+    "prettier": "^3.3.3",
+    "stylelint": "15",
+    "svgo": "^3.3.2"
+  }
+}

package/prettier-common-config.js

@@ -0,0 +1 @@
+module.exports = require('@gravity-ui/prettier-config');

package/scaffolding/.eslintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+    root: true,
+    extends: require.resolve('@diplodoc/lint/eslint-config'),
+    parserOptions: {
+        tsconfigRootDir: __dirname,
+        project: ['./tsconfig.json'],
+    },
+};

package/scaffolding/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run pre-commit

package/scaffolding/.lintstagedrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+    '**/*.{js,jsx,ts,tsx}': ['prettier --write', 'eslint --max-warnings=0 --fix'],
+    '**/*.{css,scss}': ['prettier --write', 'stylelint --fix'],
+    '**/*.{json,yaml,yml,md}': ['prettier --write'],
+    '**/*.{svg}': ['npm run svgo'],
+};

package/scaffolding/.prettierrc.js

@@ -0,0 +1 @@
+module.exports = require('@diplodoc/lint/prettier-config');

package/scaffolding/.stylelintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+    extends: require.resolve('@diplodoc/lint/stylelint-config')
+};

package/scripts/modify-ignore.js

@@ -0,0 +1,75 @@
+const {readFileSync, writeFileSync} = require('fs');
+
+const SYSTEM = [
+    '.idea',
+    '.vscode',
+    '.history',
+    '.env',
+    '.DS_Store',
+];
+const ARTIFACTS = [
+    '/lib',
+    '/dist',
+    '/build',
+    '/cache',
+    '/coverage',
+];
+const INSTALL = [
+    'node_modules',
+];
+
+const ignores = {
+    '.gitignore': [
+        ...SYSTEM,
+        ...INSTALL,
+        ...ARTIFACTS,
+        '/.eslintrc.js',
+        '/.prettierrc.js',
+        '/.stylelintrc.js',
+        '/.lintstagedrc.js',
+        // '/.eslinignore',
+        // '/.prettierignore',
+        // '/.stylelintignore',
+    ],
+    '.eslintignore': [
+        ...SYSTEM,
+        ...INSTALL,
+        ...ARTIFACTS,
+    ],
+    '.prettierignore': [
+        ...SYSTEM,
+        ...INSTALL,
+        ...ARTIFACTS,
+    ],
+    '.stylelintignore': [
+        ...SYSTEM,
+        ...INSTALL,
+        ...ARTIFACTS,
+    ]
+};
+
+for (const [file, list] of Object.entries(ignores)) {
+    const filename = process.cwd() + '/' + file;
+
+    let source;
+    try {
+        source = readFileSync(filename, 'utf8').split('\n');
+    } catch {
+        source = [];
+    }
+
+    console.log('[@diplodoc/lint]', 'Update', file);
+
+    for (const rule of list) {
+        add(source, rule);
+    }
+
+    writeFileSync(filename, source.join('\n'), 'utf8');
+}
+
+function add(source, ignore) {
+    if (!source.includes(ignore)) {
+        source.push(ignore);
+        console.log('[@diplodoc/lint]', '=> Add', ignore);
+    }
+}

package/scripts/modify-package.js

@@ -0,0 +1,27 @@
+const filename = process.cwd() + '/package.json';
+const {readFileSync, writeFileSync} = require('fs');
+
+let pkg;
+try {
+    pkg = JSON.parse(readFileSync(filename));
+} catch {
+    throw 'Unable to modify ' + filename;
+}
+
+function configure(command, impl) {
+    if (pkg.scripts[command]) {
+        if (pkg.scripts[command] !== impl) {
+            throw `Lint command '${command}' already configured with different program`;
+        }
+    } else {
+        pkg.scripts[command] = impl;
+        console.log('=> Add', command, 'script');
+    }
+}
+
+configure('lint', 'lint init && lint');
+configure('lint:fix', 'lint init && lint --fix');
+configure('pre-commit', 'lint init && lint-staged');
+configure('prepare', 'husky install || true');
+
+writeFileSync(filename, JSON.stringify(pkg, null, 2), 'utf8');

package/stylelint-common-config.js

@@ -0,0 +1,6 @@
+module.exports = {
+    extends: [
+        require.resolve('@gravity-ui/stylelint-config'),
+        require.resolve('@gravity-ui/stylelint-config/prettier')
+    ]
+};