{"_id":"@arinoto/rougher","_rev":"1-cb07709623c6b926c6112f8f29d5c3c7","name":"@arinoto/rougher","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@arinoto/rougher","description":"Customisable Rough up an SVG using Rough.js.","version":"1.0.0","license":"MIT","homepage":"https://github.com/dooreelko/rougher","author":{"name":"Daniel Perez Alvarez","email":"unindented@gmail.com","url":"http://unindented.org/"},"repository":{"type":"git","url":"git+https://github.com/dooreelko/rougher.git"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"bin":{"rougher":"dist/cli/rougher.js"},"browser":"dist/browser/rougher.js","main":"dist/node/rougher.js","types":"src/node/index.ts","module":"dist/node/rougher.mjs","engines":{"node":">=14","npm":">=6"},"scripts":{"clean:coverage":"rimraf coverage","clean:dist":"rimraf dist","clean":"run-p clean:*","build:dist":"rollup --config config/rollup/config.js","build:chmod":"chmod +x dist/cli/rougher.js","build":"run-s clean build:*","test:lint":"eslint --ext .js,.ts .","test:unit":"jest --coverage --config config/jest/config.json","test":"run-s test:*","watch:unit":"npm run test:unit -- --watch","watch:build":"npm run build:dist -- --watch","prepublishOnly":"npm run build","semantic-release":"semantic-release"},"dependencies":{"arg":"^5.0.0","chalk":"^4.1.0","jsdom":"^16.4.0","roughjs":"^4.3.1","w3c-xmlserializer":"^2.0.0"},"devDependencies":{"@commitlint/cli":"^11.0.0","@commitlint/config-conventional":"^11.0.0","@rollup/plugin-commonjs":"^17.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.0.0","@rollup/plugin-typescript":"^8.0.0","@semantic-release/changelog":"^5.0.1","@semantic-release/git":"^9.0.0","@types/jsdom":"^16.2.5","@types/w3c-xmlserializer":"^2.0.2","@typescript-eslint/eslint-plugin":"^4.9.0","@typescript-eslint/parser":"^4.9.0","commitizen":"^4.2.2","conventional-changelog-conventionalcommits":"^4.5.0","cz-conventional-changelog":"^3.3.0","eslint":"^7.14.0","eslint-config-prettier":"^6.15.0","eslint-plugin-import":"^2.22.1","eslint-plugin-jest":"^24.1.3","eslint-plugin-jest-formatting":"^2.0.0","eslint-plugin-prettier":"^3.1.4","husky":"^4.3.0","jest":"^26.6.3","npm-run-all":"^4.1.5","prettier":"^2.2.1","rimraf":"^3.0.2","rollup":"^2.34.0","rollup-plugin-terser":"^7.0.2","semantic-release":"^17.3.0","ts-jest":"^26.4.4","typescript":"^4.1.2"},"husky":{"hooks":{"commit-msg":"commitlint -V -E HUSKY_GIT_PARAMS"}},"commitlint":{"extends":["@commitlint/config-conventional"]},"config":{"commitizen":{"path":"cz-conventional-changelog"}},"gitHead":"66e9bb8f651894f81ac208f54e40fac4342b3ef5","bugs":{"url":"https://github.com/dooreelko/rougher/issues"},"_id":"@arinoto/rougher@1.0.0","_nodeVersion":"18.6.0","_npmVersion":"8.13.2","dist":{"integrity":"sha512-5mPeXfwtUvxW6ET5bZLp3395oXpOygt1DanHgmHHIhrCk/ODiRq3fRRPxBLhHslJPlwVRgR9nmUV/n+NFfuLKQ==","shasum":"61c001716baf60f749562edfded41af97042a972","tarball":"https://registry.npmjs.org/@arinoto/rougher/-/rougher-1.0.0.tgz","fileCount":10,"unpackedSize":277598,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDBAZorpjoIyLeg77Zc4GChK0WIpEy5TKZiY9xbMdTpYgIgCQ2UsTmEMhs4+77Zk5gk0TJld+AnE4bmPCNOBkd2My8="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjUVZiACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrszA/+NK/SYGS5o45zMbvrPBqnZxe4zOltks1STxLuQUyDWv2us3hq\r\n+mxUhThpY2c5dASLGABWGUY8Hkt1R43LVHiJYa+hf3VSjC0Xy6QqBD0HRU8c\r\niRq2uKsg6RjcNHgzcLgncY4xg7VqE7uuzR+jnzRMZBIQ9ys/9dDNW1KSKYxi\r\nEaVKuzPgvbagjwCQscGIHEwruxaPvaBniP0STWxP9Wvk+MEjovMFA3jImQ5P\r\nQotDDdAlazKTR/p9TSIOuOuTgCEs3DBBz86mPTYFm+Z3dA1dN9FCRZovEDk8\r\nDEqxNNGMhx6DMKte8rPVNn/yV0cdKZI2P3ms0C/Y6VeryYSaZFa/fHcXlq5s\r\ngkwUPYWQw/GsmnoUaAQjrokMJbsCEsDs3WGOuJKvzHlKSeqSipK4nq1IEIBE\r\niIgNBuniQ7zJRCipZTsylooymwBaWPDX+EGec2LzKVjQmTf/JmKpplByKDil\r\n/8Zdfyeg6WPmr1x7E20SjKpMpMFxFDdm1cucKr8FfWdnlD6LPGKBjlbq06Kj\r\nxjVCBpD3N9PLJo8ylgs677xQQqjT23F7qfNzhXD4vqNXarKTJbwYO3lrmOpP\r\nKVeAYp5NqCYn7m3SMO0h1gQZ/Po2ZOLijQQYfMq0jVjHkAzd40BIS7tExYN6\r\ncJ7G1/D7Z+ngQy6hckS0k2hisleGrjOABnM=\r\n=atuh\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dw0","email":"sascha.fedorenko@protonmail.com"},"directories":{},"maintainers":[{"name":"dw0","email":"sascha.fedorenko@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rougher_1.0.0_1666274914021_0.4812303274292198"},"_hasShrinkwrap":false},"1.1.0":{"name":"@arinoto/rougher","description":"Customisable Rough up an SVG using Rough.js.","version":"1.1.0","license":"MIT","homepage":"https://github.com/dooreelko/rougher","author":{"name":"Daniel Perez Alvarez","email":"unindented@gmail.com","url":"http://unindented.org/"},"repository":{"type":"git","url":"git+https://github.com/dooreelko/rougher.git"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"bin":{"rougher":"dist/cli/rougher.js"},"browser":"dist/browser/rougher.js","main":"dist/node/rougher.js","types":"dist/node/src/node/index.d.ts","module":"dist/node/rougher.mjs","engines":{"node":">=14","npm":">=6"},"scripts":{"clean:coverage":"rimraf coverage","clean:dist":"rimraf dist","clean":"run-p clean:*","build:dist":"rollup --config config/rollup/config.js","build:chmod":"chmod +x dist/cli/rougher.js","build":"run-s clean build:*","test:lint":"eslint --ext .js,.ts .","test:unit":"jest --coverage --config config/jest/config.json","test":"run-s test:*","watch:unit":"npm run test:unit -- --watch","watch:build":"npm run build:dist -- --watch","prepublishOnly":"npm run build","semantic-release":"semantic-release"},"dependencies":{"arg":"^5.0.0","chalk":"^4.1.0","jsdom":"^16.4.0","roughjs":"^4.3.1","w3c-xmlserializer":"^2.0.0"},"devDependencies":{"@commitlint/cli":"^11.0.0","@commitlint/config-conventional":"^11.0.0","@rollup/plugin-commonjs":"^17.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.0.0","@rollup/plugin-typescript":"^8.0.0","@semantic-release/changelog":"^5.0.1","@semantic-release/git":"^9.0.0","@types/jsdom":"^16.2.5","@types/w3c-xmlserializer":"^2.0.2","@typescript-eslint/eslint-plugin":"^4.9.0","@typescript-eslint/parser":"^4.9.0","commitizen":"^4.2.2","conventional-changelog-conventionalcommits":"^4.5.0","cz-conventional-changelog":"^3.3.0","eslint":"^7.14.0","eslint-config-prettier":"^6.15.0","eslint-plugin-import":"^2.22.1","eslint-plugin-jest":"^24.1.3","eslint-plugin-jest-formatting":"^2.0.0","eslint-plugin-prettier":"^3.1.4","husky":"^4.3.0","jest":"^26.6.3","npm-run-all":"^4.1.5","prettier":"^2.2.1","rimraf":"^3.0.2","rollup":"^2.34.0","rollup-plugin-terser":"^7.0.2","semantic-release":"^17.3.0","ts-jest":"^26.4.4","typescript":"^4.1.2"},"husky":{"hooks":{"commit-msg":"commitlint -V -E HUSKY_GIT_PARAMS"}},"commitlint":{"extends":["@commitlint/config-conventional"]},"config":{"commitizen":{"path":"cz-conventional-changelog"}},"gitHead":"66e9bb8f651894f81ac208f54e40fac4342b3ef5","bugs":{"url":"https://github.com/dooreelko/rougher/issues"},"_id":"@arinoto/rougher@1.1.0","_nodeVersion":"18.12.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-NgWAwXXxLJ8JPM4zn4ZHSVjC5Ga5QHFLnYAbfgftMSwLlXam1vTy0CmKB7tLokP0YdQcYLi1PSV9ONHWILgy6A==","shasum":"e1233e4cae6d14dbaddb8324e30781dce53450ca","tarball":"https://registry.npmjs.org/@arinoto/rougher/-/rougher-1.1.0.tgz","fileCount":70,"unpackedSize":288856,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDpbbUsa/ipts2I2a9RFIZvWMq82omnyQ9mKpyoncUp7QIgPtRkbaiCENmMxvuNIOrAw1fSJOq2iMo2f82U40WmsoA="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjWne1ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpQKg/9FTB/4efshDVVChhKqliz0W041vKwSEF2vVQ6q9ykBajS0TWj\r\nSZj6RLeiYvzZcZmUAWdZgXUap3ysXdhX63+YYMZSlbZzDlLrroZ8gMz87woc\r\n4dKfrieu4ktxa+un/maDa64A9uHm8mF9ahfxAxrYgiHvoEXVLJZrD21WNUhb\r\noPQJJQ/QDTPa06cBfZgQx0f/vrQ+M+rsafPdWYUhwltb1fMl2WkRI8Yzfzg3\r\nH+lGq2tKYLRHxQREv/VvxON/RkBomPVJ9JkKtZrMp5ECCwrPLftxDuwtpy58\r\nhuap6hheWE3RXeiuDcm6S07eDSv43wAglgrk/fSVxrJCDt84Q07mAseVlAme\r\n8pQeHpXzOiNcU3+k4MA5NkJgBvtDmaYPmqIeM+rVb2x63C1JZTGshKA+/APg\r\nYNXtc8PHNS354v0l9WqyhlekUis9ifqOrVaX65JqIQ3raGHJPCSkZZZXDK0z\r\n29DHBPefxCisDzi5x9/barwqW8RPliAOdeuCYfmOz5Bwh6yAJSfPKTMOjCPm\r\nkAdYOsqRhv/43mYYL/5dRJuxwXwdm748PES9h7Cimcz2PzkD8uwWgs8lvrIG\r\nf4C9nL0OZR6S4zKd8fUK4L/7yP3yPu8BijC+AKa2wLnK8hESYHnLG3XcGSPJ\r\nVzX/b5NY2yYxFvQd9766tlaBnkjAAEmldnI=\r\n=fUZX\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dw0","email":"sascha.fedorenko@protonmail.com"},"directories":{},"maintainers":[{"name":"dw0","email":"sascha.fedorenko@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rougher_1.1.0_1666873269471_0.06206434893907686"},"_hasShrinkwrap":false}},"time":{"created":"2022-10-20T14:08:33.956Z","1.0.0":"2022-10-20T14:08:34.171Z","modified":"2022-10-27T12:21:09.712Z","1.1.0":"2022-10-27T12:21:09.622Z"},"maintainers":[{"name":"dw0","email":"sascha.fedorenko@protonmail.com"}],"description":"Customisable Rough up an SVG using Rough.js.","homepage":"https://github.com/dooreelko/rougher","repository":{"type":"git","url":"git+https://github.com/dooreelko/rougher.git"},"author":{"name":"Daniel Perez Alvarez","email":"unindented@gmail.com","url":"http://unindented.org/"},"bugs":{"url":"https://github.com/dooreelko/rougher/issues"},"license":"MIT","readme":"# rougher ✏️\n\nRough up an SVG using Rough.js.\n\n## Table of contents\n\n- [Install](#install)\n- [Usage](#usage)\n  - [CLI](#cli)\n  - [Node (ESM)](#node-esm)\n  - [Node (CJS)](#node-cjs)\n  - [Browser (ESM)](#browser-esm)\n  - [Browser (IIFE)](#browser-iife)\n- [Build](#build)\n- [Test](#test)\n- [Meta](#meta)\n- [Contributors](#contributors)\n- [License](#license)\n\n## Install\n\nTo install:\n\n```\nnpm install rougher\n```\n\nOr if you prefer using Yarn:\n\n```\nyarn add rougher\n```\n\n## Usage\n\n### CLI\n\nTo get help:\n\n```\nrougher --help\n```\n\nTo process a file and output to stdout:\n\n```\nrougher input.svg\n```\n\nTo process a file and output to a file:\n\n```\nrougher input.svg -o output.svg\n```\n\nTo pipe the output of another command into `rougher`:\n\n```\ncat input.svg | rougher\n```\n\n### Node (ESM)\n\n```js\nimport { readFileSync } from \"fs\";\nimport roughUp from \"rougher\";\n\nconst inputContents = readFileSync(\"input.svg\");\nconsole.log(roughUp(inputContents.toString()));\n```\n\n### Node (CJS)\n\n```js\nconst { readFileSync } = require(\"fs\");\nconst roughUp = require(\"rougher\");\n\nconst inputContents = readFileSync(\"input.svg\");\nconsole.log(roughUp(inputContents.toString()));\n```\n\n### Browser (ESM)\n\n```html\n<script type=\"module\">\n  import rougher from \"https://unpkg.com/rougher/dist/browser/rougher.mjs\";\n\n  rougher(document.getElementById(\"svg\"));\n</script>\n```\n\n### Browser (IIFE)\n\n```html\n<script src=\"https://unpkg.com/rougher/dist/browser/rougher.js\"></script>\n<script>\n  rougher(document.getElementById(\"svg\"));\n</script>\n```\n\n## Configuration\n```typescript\nroughUp(input: string, options: Options & Customiser = {}): string\n```\n\nWhere `Options` are the [options you normally pass to `rough.js`](https://github.com/rough-stuff/rough/wiki#options)\n\nThe `Customiser` is an interface that has two optional fields:\n\n```typescript\nexport interface Customiser {\n  /**\n   * hook to return custom options for element. return nothing to proceed with the default.\n   */\n  customOptions?: (path: string[], element: SVGElement, options: Options) => Options | undefined;\n\n  /**\n   * hook to return custom svg element. return nothing to proceed with the default.\n   */\n  decider?: (path: string[], before: SVGGElement, after: SVGGElement) => SVGGElement | undefined;\n} \n```\n\nThe `customOptions` allows you to apply custom options for a specific element.\nThe `decider` allows you to customise which SVG element to use as a replacement.\n\n## Build\n\nTo build:\n\n```\nnpm run build\n```\n\nTo continuously build on changes:\n\n```\nnpm run watch:build\n```\n\n## Test\n\nTo run linting and unit tests:\n\n```\nnpm test\n```\n\nTo run just unit tests:\n\n```\nnpm run test:unit\n```\n\nTo continuously run unit tests on changes:\n\n```\nnpm run watch:unit\n```\n\n## Meta\n\n- Code: `git clone git://github.com/unindented/rougher.git`\n- Home: <https://github.com/unindented/rougher>\n\n## Contributors\n\n- Daniel Perez Alvarez (<https://github.com/unindented>)\n\n## License\n\nThis is free software, and may be redistributed under the terms specified in the LICENSE file.\n","readmeFilename":"README.md"}