@chegg-configs/lint-staged 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2021
+
+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
+(including the next paragraph) 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,20 @@
+# @chegg-configs/lint-staged
+
+A base configuration for chegg lint-staged — a popular tool for running linters on staged Git files.
+
+## Install
+
+```sh
+npm i @chegg-configs/lint-staged
+// or
+yarn add @chegg-configs/lint-staged
+```
+
+### Usage
+Add to your `.lintstagedrc.js`:
+
+```js
+module.exports = {
+  ...require("@chegg-configs/lint-staged"),
+};
+```

package/index.js

@@ -0,0 +1,95 @@
+const path = require('path');
+const micromatch = require('micromatch');
+
+/**
+ * lint-staged Config generator
+ *
+ * @param {string} [dir]
+ * @param {import("./types").CommandMappings} [mapping]
+ * @return {import("./types").LintStagedCommandMapper}
+ */
+export default function (dir, mapping) {
+  return (allStagedFiles) => {
+    /**
+     * @type {string[]}
+     */
+    const commandList = [];
+    const cwd = process.cwd();
+
+    dir = !dir
+      ? // 引数がないならカレントディレクトリ
+      cwd
+      : // 絶対パスかどうか
+      path.isAbsolute(dir)
+        ? // 絶対パスならそのまま
+        dir
+        : // 相対パスなら絶対パスに変換
+        path.resolve(cwd, dir);
+
+    mapping = mapping ?? defaultMapping;
+
+    Object.entries(mapping).forEach(([ext, commandTypes]) => {
+      commandTypes.forEach((commandType) => {
+        const shell = commands[commandType];
+
+        if (!shell) {
+          return;
+        }
+
+        const pattern = path
+          .resolve(dir, '**', `{*.${ext},.*.${ext}}`)
+          .replaceAll(path.sep, '/');
+
+        const files = allStagedFiles.map((f) => f.replaceAll(path.sep, '/'));
+
+        const targetFiles = micromatch(files, pattern);
+
+        if (targetFiles.length <= 0) {
+          return;
+        }
+
+        commandList.push(shell + ' ' + targetFiles.map((f) => `"${f}"`).join(' '));
+      });
+    });
+
+    return commandList;
+  };
+}
+
+/**
+ * @type {Record<import("./types").CommandType, string>}
+ */
+export const commands = {
+  cspell: 'cspell --no-must-find-files --show-suggestions',
+  eslint: 'eslint --fix',
+  markuplint: 'markuplint',
+  prettier: 'prettier --write',
+  puglint: 'pug-lint',
+  stylelint: 'stylelint --fix',
+};
+
+/**
+ * @type {import("./types").CommandMappings}
+ */
+export const defaultMapping = {
+  md: ['prettier', 'textlint', 'cspell'],
+  mdx: ['prettier', 'textlint', 'cspell'],
+  json: ['prettier', 'cspell'],
+  yaml: ['cspell'],
+  yml: ['cspell'],
+  js: ['eslint', 'prettier', 'cspell'],
+  cjs: ['eslint', 'prettier', 'cspell'],
+  mjs: ['eslint', 'prettier', 'cspell'],
+  jsx: ['eslint', 'markuplint', 'prettier', 'cspell'],
+  ts: ['eslint', 'prettier', 'cspell'],
+  cts: ['eslint', 'prettier', 'cspell'],
+  mts: ['eslint', 'prettier', 'cspell'],
+  tsx: ['eslint', 'markuplint', 'prettier', 'cspell'],
+  html: ['markuplint', 'prettier', 'cspell'],
+  pug: ['markuplint', 'prettier', 'cspell'],
+  css: ['stylelint', 'prettier', 'cspell'],
+  scss: ['stylelint', 'prettier', 'cspell'],
+  astro: ['eslint', 'markuplint', 'prettier', 'cspell'],
+  svelte: ['eslint', 'markuplint', 'prettier', 'cspell'],
+  vue: ['eslint', 'markuplint', 'prettier', 'cspell'],
+};

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@chegg-configs/lint-staged",
+  "version": "1.0.0",
+  "private": false,
+  "description": "A base configuration for chegg lint-staged — a popular tool for running linters on staged Git files.",
+  "license": "MIT",
+  "author": "hchgg-lpc",
+  "main": "li",
+  "repository": "https://www.github.com/hchgg-lpc/chegg-configs/lint-staged",
+  "scripts": {
+    "build": "node build.js",
+    "test": "exit 0"
+  },
+  "dependencies": {
+    "micromatch": "^4.0.5"
+  },
+  "devDependencies": {
+    "lint-staged": "^13.2.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}