svg-path-commander 2.1.2 → 2.1.5

package/package.json

@@ -2,8 +2,8 @@
   "name": "svg-path-commander",
   "author": "thednp",
   "license": "MIT",
-  "version": "2.1.2",
-  "description": "Modern TypeScript tools for SVG",
+  "version": "2.1.5",
+  "description": "🛹 Modern TypeScript tools for SVG",
   "source": "./src/index.ts",
   "main": "./dist/svg-path-commander.js",
   "module": "./dist/svg-path-commander.mjs",
@@ -38,21 +38,14 @@
   },
   "homepage": "http://thednp.github.io/svg-path-commander",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
-    "@vitest/browser": "^2.1.3",
-    "@vitest/coverage-istanbul": "^2.1.3",
-    "@vitest/ui": "^2.1.3",
-    "dts-bundle-generator": "^9.5.1",
-    "eslint": "^8.57.1",
-    "eslint-plugin-jsdoc": "^46.10.1",
-    "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-prettier": "^4.2.1",
-    "playwright": "^1.48.1",
-    "prettier": "^2.8.8",
+    "@vitest/browser": "^2.1.4",
+    "@vitest/coverage-istanbul": "^2.1.4",
+    "@vitest/ui": "^2.1.4",
+    "playwright": "^1.48.2",
     "typescript": "^5.6.3",
-    "vite": "^5.4.9",
-    "vitest": "^2.1.3"
+    "vite": "^5.4.10",
+    "vite-plugin-dts": "^4.3.0",
+    "vitest": "^2.1.4"
   },
   "dependencies": {
     "@thednp/dommatrix": "^2.0.8"
@@ -63,19 +56,18 @@
   },
   "scripts": {
     "pre-test": "pnpm clean-coverage",
-    "badges": "npx -p dependency-version-badge update-badge typescript eslint prettier vitest vite",
+    "badges": "npx -p dependency-version-badge update-badge typescript vitest vite",
     "dev": "vite serve docs --port 3000",
     "test": "pnpm pre-test && vitest --config vitest.config.mts",
     "test-ui": "pnpm pre-test && vitest --config vitest.config-ui.mts --browser=chrome",
     "clean-coverage": "rm -rf coverage .nyc_output",
-    "format": "prettier --write \"src/**/*.ts\"",
+    "format": "deno fmt src",
     "lint": "pnpm lint:ts && pnpm check:ts",
-    "fix:ts": "eslint src --config .eslintrc.cjs --fix",
-    "lint:ts": "eslint src --config .eslintrc.cjs",
+    "fix:ts": "deno lint --fix src",
+    "lint:ts": "deno lint src",
     "check:ts": "tsc --noEmit",
-    "build": "pnpm lint && pnpm build-vite && pnpm build-ts",
+    "build": "pnpm build-vite",
     "build-vite": "vite build && pnpm copy-docs",
-    "build-ts": "dts-bundle-generator --config ./dts.config.ts",
     "copy-docs": "cp dist/svg-path-commander.js docs/svg-path-commander.js && cp dist/svg-path-commander.js.map docs/svg-path-commander.js.map"
   }
 }

package/.eslintrc.cjs

@@ -1,225 +0,0 @@
-module.exports = {
-    "env": {
-        "browser": true,
-        "es6": true
-    },
-    "extends": [
-        "plugin:@typescript-eslint/recommended",
-        "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "project": "tsconfig.json",
-        "sourceType": "module"
-    },
-    "plugins": [
-        "eslint-plugin-jsdoc",
-        "eslint-plugin-prefer-arrow",
-        // "eslint-plugin-react",
-        "@typescript-eslint",
-        "prettier"
-    ],
-    "root": true,
-    "rules": {
-        "prettier/prettier": "error",
-        "@typescript-eslint/adjacent-overload-signatures": "error",
-        "@typescript-eslint/array-type": [
-            "error",
-            {
-                "default": "array"
-            }
-        ],
-        "@typescript-eslint/ban-types": [
-            "error",
-            {
-                "types": {
-                    "Object": {
-                        "message": "Avoid using the `Object` type. Did you mean `object`?"
-                    },
-                    "Function": {
-                        "message": "Avoid using the `Function` type. Prefer a specific function type, like `() => void`."
-                    },
-                    "Boolean": {
-                        "message": "Avoid using the `Boolean` type. Did you mean `boolean`?"
-                    },
-                    "Number": {
-                        "message": "Avoid using the `Number` type. Did you mean `number`?"
-                    },
-                    "String": {
-                        "message": "Avoid using the `String` type. Did you mean `string`?"
-                    },
-                    "Symbol": {
-                        "message": "Avoid using the `Symbol` type. Did you mean `symbol`?"
-                    }
-                }
-            }
-        ],
-        "@typescript-eslint/consistent-type-assertions": "error",
-        "@typescript-eslint/dot-notation": "error",
-        "@typescript-eslint/explicit-function-return-type": "off",
-        "@typescript-eslint/explicit-module-boundary-types": "off",
-        "@typescript-eslint/indent": "off",
-        "@typescript-eslint/member-delimiter-style": [
-            "off",
-            {
-                "multiline": {
-                    "delimiter": "none",
-                    "requireLast": true
-                },
-                "singleline": {
-                    "delimiter": "semi",
-                    "requireLast": false
-                }
-            }
-        ],
-        // "@typescript-eslint/naming-convention": "error",
-        "@typescript-eslint/no-empty-function": "error",
-        "@typescript-eslint/no-empty-interface": "error",
-        "@typescript-eslint/no-explicit-any": "off",
-        "@typescript-eslint/no-misused-new": "error",
-        "@typescript-eslint/no-namespace": "error",
-        "@typescript-eslint/no-parameter-properties": "off",
-        "@typescript-eslint/no-shadow": [
-            "error",
-            {
-                "hoist": "all"
-            }
-        ],
-        "@typescript-eslint/no-loss-of-precision": "off",
-        "@typescript-eslint/no-unused-expressions": "error",
-        "@typescript-eslint/no-use-before-define": "off",
-        "@typescript-eslint/no-var-requires": "error",
-        "@typescript-eslint/prefer-for-of": "error",
-        "@typescript-eslint/prefer-function-type": "error",
-        "@typescript-eslint/prefer-namespace-keyword": "error",
-        "@typescript-eslint/quotes": "off",
-        "@typescript-eslint/semi": [
-            "off",
-            null
-        ],
-        "@typescript-eslint/triple-slash-reference": [
-            "error",
-            {
-                "path": "always",
-                "types": "prefer-import",
-                "lib": "always"
-            }
-        ],
-        "@typescript-eslint/type-annotation-spacing": "off",
-        "@typescript-eslint/typedef": "off",
-        "@typescript-eslint/unified-signatures": "error",
-        "arrow-parens": [
-            "off",
-            "always"
-        ],
-        "brace-style": [
-            "off",
-            "off"
-        ],
-        "comma-dangle": "off",
-        "complexity": "off",
-        "constructor-super": "error",
-        "dot-notation": "off",
-        "eol-last": "off",
-        "eqeqeq": [
-            "error",
-            "smart"
-        ],
-        "guard-for-in": "error",
-        "id-denylist": [
-            "error",
-            "any",
-            "Number",
-            "number",
-            "String",
-            "string",
-            "Boolean",
-            "boolean",
-            "Undefined",
-            "undefined"
-        ],
-        "id-match": "error",
-        "indent": "off",
-        "jsdoc/check-alignment": "error",
-        "jsdoc/check-indentation": "error",
-        // "jsdoc/newline-after-description": "error",
-        "linebreak-style": "off",
-        "max-classes-per-file": [
-            "error",
-            1
-        ],
-        "max-len": "off",
-        "new-parens": "off",
-        "newline-per-chained-call": "off",
-        "no-bitwise": "error",
-        "no-caller": "error",
-        "no-cond-assign": "error",
-        "no-console": "error",
-        "no-debugger": "error",
-        "no-empty": "error",
-        "no-empty-function": "off",
-        "no-eval": "error",
-        "no-extra-semi": "off",
-        "no-fallthrough": "off",
-        "no-invalid-this": "off",
-        "no-irregular-whitespace": "off",
-        "no-multiple-empty-lines": "off",
-        "no-new-wrappers": "error",
-        "no-shadow": "off",
-        "no-throw-literal": "error",
-        "no-trailing-spaces": "off",
-        "no-undef-init": "error",
-        "no-underscore-dangle": "off",
-        "no-unsafe-finally": "error",
-        "no-unused-expressions": "off",
-        "no-unused-labels": "error",
-        "no-use-before-define": "off",
-        "no-var": "error",
-        "object-shorthand": "error",
-        "one-var": [
-            "error",
-            "never"
-        ],
-        "padded-blocks": [
-            "off",
-            {
-                "blocks": "never"
-            },
-            {
-                "allowSingleLineBlocks": true
-            }
-        ],
-        "prefer-arrow/prefer-arrow-functions": "error",
-        "prefer-const": "error",
-        "quote-props": "off",
-        "quotes": "off",
-        "radix": "error",
-        // "react/jsx-curly-spacing": "off",
-        // "react/jsx-equals-spacing": "off",
-        // "react/jsx-tag-spacing": [
-        //     "off",
-        //     {
-        //         "afterOpening": "allow",
-        //         "closingSlash": "allow"
-        //     }
-        // ],
-        // "react/jsx-wrap-multilines": "off",
-        "semi": "off",
-        "space-before-function-paren": "off",
-        "space-in-parens": [
-            "off",
-            "never"
-        ],
-        "spaced-comment": [
-            "error",
-            "always",
-            {
-                "markers": [
-                    "/"
-                ]
-            }
-        ],
-        "use-isnan": "error",
-        "valid-typeof": "off"
-    }
-};

package/.prettierrc.json

@@ -1,15 +0,0 @@
-{
-  "arrowParens": "avoid",
-  "bracketSpacing": true,
-  "endOfLine": "lf",
-  "bracketSameLine": false,
-  "jsxSingleQuote": false,
-  "printWidth": 120,
-  "proseWrap": "preserve",
-  "quoteProps": "as-needed",
-  "semi": true,
-  "singleQuote": true,
-  "tabWidth": 2,
-  "trailingComma": "all",
-  "useTabs": false
-}

package/dts.config.ts

@@ -1,15 +0,0 @@
-const config = {
-  entries: [
-    {
-      filePath: "./src/index.ts",
-      outFile: "./dist/svg-path-commander.d.ts",
-      noCheck: false,
-      output: {
-        umdModuleName: 'SVGPathCommander',
-        noBanner: true,
-      }
-    },
-  ],
-};
-
-module.exports = config;

package/src/convert/pathToAbsolute.ts

@@ -1,18 +0,0 @@
-import parsePathString from '../parser/parsePathString';
-import absolutizeSegment from '../process/absolutizeSegment';
-import type { AbsoluteArray, PathArray } from '../types';
-import iterate from '../process/iterate';
-
-/**
- * Parses a path string value or object and returns an array
- * of segments, all converted to absolute values.
- *
- * @param pathInput the path string | object
- * @returns the resulted `pathArray` with absolute values
- */
-const pathToAbsolute = (pathInput: string | PathArray) => {
-  const path = parsePathString(pathInput);
-
-  return iterate<AbsoluteArray>(path, absolutizeSegment);
-};
-export default pathToAbsolute;

package/src/convert/pathToCurve.ts

@@ -1,43 +0,0 @@
-import segmentToCubic from '../process/segmentToCubic';
-import { AbsoluteCommand, CSegment, CurveArray, PathArray } from '../types';
-import iterate from '../process/iterate';
-import parsePathString from '../parser/parsePathString';
-import normalizeSegment from '../process/normalizeSegment';
-import paramsParser from '../parser/paramsParser';
-
-/**
- * Parses a path string value or 'pathArray' and returns a new one
- * in which all segments are converted to cubic-bezier.
- *
- * In addition, un-necessary `Z` segment is removed if previous segment
- * extends to the `M` segment.
- *
- * @param pathInput the string to be parsed or 'pathArray'
- * @returns the resulted `pathArray` converted to cubic-bezier
- */
-const pathToCurve = (pathInput: string | PathArray): CurveArray => {
-  const params = { ...paramsParser };
-  const path = parsePathString(pathInput);
-
-  return iterate<CurveArray>(path, (seg, index, lastX, lastY) => {
-    params.x = lastX;
-    params.y = lastY;
-    const normalSegment = normalizeSegment(seg, params);
-    let result = segmentToCubic(normalSegment, params);
-    const isLongArc = result[0] === 'C' && result.length > 7;
-
-    if (isLongArc) {
-      path.splice(index + 1, 0, ['C' as AbsoluteCommand | number].concat(result.slice(7)) as CSegment);
-      result = result.slice(0, 7) as CSegment;
-    }
-
-    const seglen = result.length;
-    params.x1 = +result[seglen - 2];
-    params.y1 = +result[seglen - 1];
-    params.x2 = +result[seglen - 4] || params.x1;
-    params.y2 = +result[seglen - 3] || params.y1;
-
-    return result;
-  });
-};
-export default pathToCurve;

package/src/convert/pathToRelative.ts

@@ -1,18 +0,0 @@
-import type { PathArray, RelativeArray } from '../types';
-import parsePathString from '../parser/parsePathString';
-import iterate from '../process/iterate';
-import relativizeSegment from '../process/relativizeSegment';
-
-/**
- * Parses a path string value or object and returns an array
- * of segments, all converted to relative values.
- *
- * @param pathInput the path string | object
- * @returns the resulted `pathArray` with relative values
- */
-const pathToRelative = (pathInput: string | PathArray): RelativeArray => {
-  const path = parsePathString(pathInput);
-
-  return iterate<RelativeArray>(path, relativizeSegment);
-};
-export default pathToRelative;

package/src/convert/pathToString.ts

@@ -1,50 +0,0 @@
-import type { PathArray, PathSegment } from '../types';
-import defaultOptions from '../options/options';
-import roundTo from '../math/roundTo';
-
-/**
- * Returns a valid `d` attribute string value created
- * by rounding values and concatenating the `pathArray` segments.
- *
- * @param path the `pathArray` object
- * @param roundOption amount of decimals to round values to
- * @returns the concatenated path string
- */
-const pathToString = (path: PathArray, roundOption?: number | 'off'): string => {
-  const pathLen = path.length;
-  let { round } = defaultOptions;
-  let segment = path[0] as PathSegment;
-  let result = '';
-
-  // allow for ZERO decimals
-  round =
-    roundOption === 'off'
-      ? roundOption
-      : typeof roundOption === 'number' && roundOption >= 0
-      ? roundOption
-      : typeof round === 'number' && round >= 0
-      ? round
-      : /* istanbul ignore next @preserve */ 'off';
-
-  for (let i = 0; i < pathLen; i += 1) {
-    segment = path[i];
-    const [pathCommand] = segment;
-    const values = segment.slice(1) as number[];
-    result += pathCommand;
-    if (round === 'off') {
-      result += values.join(' ');
-    } else {
-      let j = 0;
-      const valLen = values.length;
-      while (j < valLen) {
-        result += roundTo(values[j], round);
-        if (j !== valLen - 1) result += ' ';
-        j += 1;
-      }
-    }
-  }
-
-  return result;
-};
-
-export default pathToString;