eslint-plugin-svg 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-PRESENT ntnyq <https://github.com/ntnyq>
+
+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,58 @@
+# eslint-plugin-svg
+
+[![CI](https://github.com/ntnyq/eslint-plugin-svg/workflows/CI/badge.svg)](https://github.com/ntnyq/eslint-plugin-svg/actions)
+[![NPM VERSION](https://img.shields.io/npm/v/eslint-plugin-svg.svg)](https://www.npmjs.com/package/eslint-plugin-svg)
+[![NPM DOWNLOADS](https://img.shields.io/npm/dy/eslint-plugin-svg.svg)](https://www.npmjs.com/package/eslint-plugin-svg)
+[![CODECOV](https://codecov.io/github/ntnyq/eslint-plugin-svg/branch/main/graph/badge.svg)](https://codecov.io/github/ntnyq/eslint-plugin-svg)
+[![LICENSE](https://img.shields.io/github/license/ntnyq/eslint-plugin-svg.svg)](https://github.com/ntnyq/eslint-plugin-svg/blob/main/LICENSE)
+
+> Rules for consistent, readable and valid SVG files.
+
+> [!WARNING]
+> This plugin is Work In Progress. API may change at every release. Please use with caution.
+
+## Install
+
+```bash
+npm install eslint-plugin-svg -D
+```
+
+```bash
+yarn add eslint-plugin-svg -D
+```
+
+```bash
+pnpm add eslint-plugin-svg -D
+```
+
+## Usage
+
+Config in ESLint config files:
+
+```ts
+import pluginSvg from 'eslint-plugin-svg'
+
+/**
+ * @type {import('eslint').Linter.Config[]}
+ */
+export default [
+  ...pluginSvg.configs.recommended,
+  // Other configs...
+]
+```
+
+:apple: For advanced usaged, please check [Advanced Usage](https://eslint-plugin-svg.ntnyq.com/guide/#advanced-usage)
+
+## Rules
+
+💼 Configurations enabled in.\
+✅ Set in the `recommended` preset.\
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
+💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+
+| Name | Description | 💼  | 🔧  | 💡  |
+| :--- | :---------- | :-: | :-: | :-: |
+
+## License
+
+[MIT](./LICENSE) License © 2024-PRESENT [ntnyq](https://github.com/ntnyq)

package/dist/index.cjs

@@ -0,0 +1,89 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  configs: () => configs,
+  createRecommendedConfig: () => createRecommendedConfig,
+  default: () => src_default,
+  meta: () => meta,
+  plugin: () => plugin,
+  recommended: () => recommended,
+  rules: () => rules
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/configs/index.ts
+function createRecommendedConfig(options = {}) {
+  const config = {
+    ...options,
+    // Overrides
+    name: options.name || "svg/recommended",
+    files: options.files || ["**/*.svg"],
+    ignores: options.ignores || [],
+    languageOptions: options.languageOptions,
+    plugins: {
+      ...options.plugins || {},
+      /* v8 ignore start */
+      get svg() {
+        return plugin;
+      }
+      /* v8 ignore stop */
+    },
+    rules: {
+      ...options.overridesRules || {}
+    }
+  };
+  return config;
+}
+var recommended = [
+  // flat recommended config
+  createRecommendedConfig()
+];
+var configs = {
+  recommended
+};
+
+// src/meta.ts
+var meta = {
+  name: "eslint-plugin-svg",
+  version: "0.0.0"
+};
+
+// src/rules/index.ts
+var rules = {};
+
+// src/index.ts
+var plugin = {
+  meta,
+  // FIXME: type not match
+  rules,
+  configs
+};
+var src_default = plugin;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  configs,
+  createRecommendedConfig,
+  meta,
+  plugin,
+  recommended,
+  rules
+});

package/dist/index.d.cts

@@ -0,0 +1,57 @@
+import * as eslint from 'eslint';
+import { Linter, Rule } from 'eslint';
+
+declare const rules: {};
+
+type RuleDefinitions = typeof rules;
+type RuleOptions = {
+    [K in keyof RuleDefinitions]: RuleDefinitions[K]['defaultOptions'];
+};
+type Rules = {
+    [K in keyof RuleOptions]: Linter.RuleEntry<RuleOptions[K]>;
+};
+type RulesWithPluginName<Name extends string = 'svg'> = {
+    [K in keyof RuleOptions as `${Name}/${K}`]: Linter.RuleEntry<RuleOptions[K]>;
+};
+
+declare const meta: {
+    name: string;
+    version: string;
+};
+
+interface RecommendedOptions extends Linter.Config {
+    /**
+     * Overrides rules.
+     */
+    overridesRules?: RulesWithPluginName;
+}
+/**
+ * Create recommended config in flat style.
+ *
+ * @param options - Create recommended config {@link RecommendedOptions}.
+ * @returns flat recommended config.
+ */
+declare function createRecommendedConfig(options?: RecommendedOptions): Linter.Config<Linter.RulesRecord>;
+declare const recommended: Linter.Config<Linter.RulesRecord>[];
+declare const configs: {
+    recommended: Linter.Config<Linter.RulesRecord>[];
+};
+
+/**
+ * eslint-plugin-svg
+ * Rules for consistent, readable and valid SVG files.
+ *
+ * @see {@link https://github.com/ntnyq/eslint-plugin-svg}
+ */
+declare const plugin: {
+    meta: {
+        name: string;
+        version: string;
+    };
+    rules: Record<string, Rule.RuleModule>;
+    configs: {
+        recommended: eslint.Linter.Config<eslint.Linter.RulesRecord>[];
+    };
+};
+
+export { type RecommendedOptions, type RuleOptions, type Rules, type RulesWithPluginName, configs, createRecommendedConfig, plugin as default, meta, plugin, recommended, rules };

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import * as eslint from 'eslint';
+import { Linter, Rule } from 'eslint';
+
+declare const rules: {};
+
+type RuleDefinitions = typeof rules;
+type RuleOptions = {
+    [K in keyof RuleDefinitions]: RuleDefinitions[K]['defaultOptions'];
+};
+type Rules = {
+    [K in keyof RuleOptions]: Linter.RuleEntry<RuleOptions[K]>;
+};
+type RulesWithPluginName<Name extends string = 'svg'> = {
+    [K in keyof RuleOptions as `${Name}/${K}`]: Linter.RuleEntry<RuleOptions[K]>;
+};
+
+declare const meta: {
+    name: string;
+    version: string;
+};
+
+interface RecommendedOptions extends Linter.Config {
+    /**
+     * Overrides rules.
+     */
+    overridesRules?: RulesWithPluginName;
+}
+/**
+ * Create recommended config in flat style.
+ *
+ * @param options - Create recommended config {@link RecommendedOptions}.
+ * @returns flat recommended config.
+ */
+declare function createRecommendedConfig(options?: RecommendedOptions): Linter.Config<Linter.RulesRecord>;
+declare const recommended: Linter.Config<Linter.RulesRecord>[];
+declare const configs: {
+    recommended: Linter.Config<Linter.RulesRecord>[];
+};
+
+/**
+ * eslint-plugin-svg
+ * Rules for consistent, readable and valid SVG files.
+ *
+ * @see {@link https://github.com/ntnyq/eslint-plugin-svg}
+ */
+declare const plugin: {
+    meta: {
+        name: string;
+        version: string;
+    };
+    rules: Record<string, Rule.RuleModule>;
+    configs: {
+        recommended: eslint.Linter.Config<eslint.Linter.RulesRecord>[];
+    };
+};
+
+export { type RecommendedOptions, type RuleOptions, type Rules, type RulesWithPluginName, configs, createRecommendedConfig, plugin as default, meta, plugin, recommended, rules };

package/dist/index.js

@@ -0,0 +1,57 @@
+// src/configs/index.ts
+function createRecommendedConfig(options = {}) {
+  const config = {
+    ...options,
+    // Overrides
+    name: options.name || "svg/recommended",
+    files: options.files || ["**/*.svg"],
+    ignores: options.ignores || [],
+    languageOptions: options.languageOptions,
+    plugins: {
+      ...options.plugins || {},
+      /* v8 ignore start */
+      get svg() {
+        return plugin;
+      }
+      /* v8 ignore stop */
+    },
+    rules: {
+      ...options.overridesRules || {}
+    }
+  };
+  return config;
+}
+var recommended = [
+  // flat recommended config
+  createRecommendedConfig()
+];
+var configs = {
+  recommended
+};
+
+// src/meta.ts
+var meta = {
+  name: "eslint-plugin-svg",
+  version: "0.0.0"
+};
+
+// src/rules/index.ts
+var rules = {};
+
+// src/index.ts
+var plugin = {
+  meta,
+  // FIXME: type not match
+  rules,
+  configs
+};
+var src_default = plugin;
+export {
+  configs,
+  createRecommendedConfig,
+  src_default as default,
+  meta,
+  plugin,
+  recommended,
+  rules
+};

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "eslint-plugin-svg",
+  "type": "module",
+  "version": "0.0.0",
+  "description": "Rules for consistent, readable and valid SVG files.",
+  "keywords": [
+    "eslint",
+    "eslint-plugin",
+    "svg"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "ntnyq",
+    "email": "ntnyq13@gmail.com"
+  },
+  "homepage": "https://github.com/ntnyq/eslint-plugin-svg#readme",
+  "repository": "ntnyq/eslint-plugin-svg",
+  "bugs": {
+    "url": "https://github.com/ntnyq/eslint-plugin-svg/issues"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "eslint": "^9.5.0"
+  },
+  "dependencies": {
+    "@ntnyq/utils": "^0.4.1",
+    "@types/json-schema": "^7.0.15"
+  },
+  "devDependencies": {
+    "@ntnyq/eslint-config": "^3.9.0",
+    "@ntnyq/prettier-config": "^1.22.0",
+    "@types/node": "^22.10.1",
+    "@vitest/coverage-v8": "^2.1.8",
+    "bumpp": "^9.8.1",
+    "eslint": "^9.16.0",
+    "eslint-plugin-eslint-plugin": "^6.3.2",
+    "eslint-vitest-rule-tester": "^0.7.0",
+    "husky": "^9.1.7",
+    "nano-staged": "^0.8.0",
+    "npm-run-all2": "^7.0.1",
+    "prettier": "^3.4.2",
+    "tinyglobby": "^0.2.10",
+    "tsup": "^8.3.5",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
+  },
+  "engines": {
+    "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
+  },
+  "nano-staged": {
+    "*.{js,ts,mjs,cjs,vue,json,md,yml,yaml}": "eslint --fix"
+  },
+  "scripts": {
+    "build": "tsup",
+    "coverage": "vitest --coverage",
+    "deploy": "run-s build docs:build",
+    "dev": "tsup --watch src",
+    "docs:build": "pnpm -C docs run build",
+    "docs:dev": "pnpm -C docs run dev",
+    "lint": "eslint .",
+    "release": "run-s release:check release:publish",
+    "release:check": "run-s lint typecheck test",
+    "release:publish": "bumpp && pnpm publish",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit"
+  }
+}