feat(plugin-notches): initial release, see #757

CHANGELOG.md

@@ -3,11 +3,27 @@
 
 ## Unreleased
 
+### components
+
+#### Added
+
+ - Added some more examples to the Examples component
+
+#### Fixed
+
+ - Include basic themeing in Example component
+
+### css-theme
+
+#### Added
+
+ - Proper formatting for markdown syntax highlighting
+
 ### shin
 
 #### Fixed
 
- - Removed the unused `lengthBonus` options. Closes [#752](https://github.com/freesewing/freesewing/issues/752)
+ - Removed unused lengthBonus option
 
 
 ## 2.10.7 (2020-11-18)

config/changelog.yaml

@@ -5,6 +5,9 @@ Unreleased:
       - Added some more examples to the Examples component
     css-theme:
       - Proper formatting for markdown syntax highlighting
+    plugin-notches:
+      - Initial release. See [#757](https://github.com/freesewing/freesewing/issues/757)
+
   Changed:
   Fixed:
     components:

config/descriptions.yaml

@@ -32,7 +32,7 @@ penelope: 'A FreeSewing pattern for a pencil skirt'
 plugin-banner: 'A FreeSewing plugin to repeat text on a path'
 plugin-bundle: 'An umbrella package of 8 essential FreeSewing build-time plugins'
 plugin-bust: 'A FreeSewing plugin that helps with bust-adjusting menswear patterns'
-plugin-buttons: 'A FreeSewing plugin that provides button and buttonhole snippets'
+plugin-buttons: 'A FreeSewing plugin that provides button, buttonhole, and snap snippets'
 plugin-cutonfold: 'A FreeSewing plugin to add cut-on-fold indicators on your patterns'
 plugin-dimension: 'A FreeSewing plugin to add dimensions to your (paperless) pattern'
 plugin-export-dxf: 'A FreeSewing plugin to export your pattern as DXF-ASTM'
@@ -43,6 +43,7 @@ plugin-i18n: 'A FreeSewing plugin for pattern translation'
 plugin-logo: 'A FreeSewing plugin to add our logo to your patterns'
 plugin-measurements: 'A FreeSewing plugin that adds additional measurements that can be calculated from existing ones'
 plugin-mirror: 'A FreeSewing plugin to mirror points or paths'
+plugin-notches: 'A FreeSewing plugin that provides front and back notch snippets'
 plugin-round: 'A FreeSewing plugin to round corners'
 plugin-scalebox: 'A FreeSewing plugin to add a scalebox to your pattern'
 plugin-sprinkle: 'A FreeSewing plugin to bulk-add snippets to your pattern'

packages/plugin-bundle/src/index.js

@@ -3,6 +3,7 @@ import cutonfold from '@freesewing/plugin-cutonfold'
 import dimension from '@freesewing/plugin-dimension'
 import grainline from '@freesewing/plugin-grainline'
 import logo from '@freesewing/plugin-logo'
+import notches from '@freesewing/plugin-notches'
 import title from '@freesewing/plugin-title'
 import scalebox from '@freesewing/plugin-scalebox'
 import round from '@freesewing/plugin-round'
@@ -10,7 +11,18 @@ import sprinkle from '@freesewing/plugin-sprinkle'
 import measurements from '@freesewing/plugin-measurements'
 import { version, name } from '../package.json'
 
-let bundle = [cutonfold, dimension, grainline, logo, title, scalebox, round, sprinkle, measurements]
+let bundle = [
+  cutonfold,
+  dimension,
+  grainline,
+  logo,
+  notches,
+  title,
+  scalebox,
+  round,
+  sprinkle,
+  measurements
+]
 
 function bundleHooks() {
   let hooks = {}

packages/plugin-buttons/README.md

@@ -46,7 +46,7 @@
 This repository is our *monorepo* holding [all our NPM packages](https://www.npmjs.com/search?q=keywords:freesewing).  
 This folder holds **@freesewing/plugin-buttons**
 
-A FreeSewing plugin that provides button and buttonhole snippets
+A FreeSewing plugin that provides button, buttonhole, and snap snippets
 
 
 

packages/plugin-buttons/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@freesewing/plugin-buttons",
   "version": "2.10.8-rc.0",
-  "description": "A FreeSewing plugin that provides button and buttonhole snippets",
+  "description": "A FreeSewing plugin that provides button, buttonhole, and snap snippets",
   "author": "Joost De Cock <joost@decock.org> (https://github.com/joostdecock)",
   "homepage": "https://freesewing.org/",
   "repository": "github:freesewing/freesewing",

packages/plugin-notches/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change log for: @freesewing/plugin-notches
+
+
+
+This is the **initial release**, and the start of this change log.
+
+> Prior to version 2, FreeSewing was not a JavaScript project.
+> As such, that history is out of scope for this change log.
+

packages/plugin-notches/README.md

@@ -0,0 +1,100 @@
+![FreeSewing](https://freesewing.org/banner.jpg)
+<p align='center'><a
+  href="https://www.npmjs.com/package/@freesewing/plugin-notches"
+  title="@freesewing/plugin-notches on NPM"
+  ><img src="https://img.shields.io/npm/v/@freesewing/plugin-notches.svg"
+  alt="@freesewing/plugin-notches on NPM"/>
+  </a><a
+  href="https://opensource.org/licenses/MIT"
+  title="License: MIT"
+  ><img src="https://img.shields.io/npm/l/@freesewing/plugin-notches.svg?label=License"
+  alt="License: MIT"/>
+  </a><a
+  href="https://deepscan.io/dashboard#view=project&tid=2114&pid=2993&bid=23256"
+  title="Code quality on DeepScan"
+  ><img src="https://deepscan.io/api/teams/2114/projects/2993/branches/23256/badge/grade.svg"
+  alt="Code quality on DeepScan"/>
+  </a><a
+  href="https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-notches"
+  title="Open issues tagged pkg:plugin-notches"
+  ><img src="https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-notches.svg?label=Issues"
+  alt="Open issues tagged pkg:plugin-notches"/>
+  </a></p><p align='center'><a
+  href="https://twitter.com/freesewing_org"
+  title="Follow @freesewing_org on Twitter"
+  ><img src="https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-blue.svg?logo=twitter&logoColor=white&logoWidth=15"
+  alt="Follow @freesewing_org on Twitter"/>
+  </a><a
+  href="https://chat.freesewing.org"
+  title="Chat with us on Discord"
+  ><img src="https://img.shields.io/discord/698854858052075530?label=Chat%20on%20Discord"
+  alt="Chat with us on Discord"/>
+  </a><a
+  href="https://freesewing.org/patrons/join"
+  title="Become a FreeSewing Patron"
+  ><img src="https://img.shields.io/badge/%F3%A0%80%A0-Support%20us-blueviolet.svg?logo=cash-app&logoColor=white&logoWidth=15"
+  alt="Become a FreeSewing Patron"/>
+  </a><a
+  href="https://instagram.com/freesewing_org"
+  title="Follow @freesewing_org on Twitter"
+  ><img src="https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-E4405F.svg?logo=instagram&logoColor=white&logoWidth=15"
+  alt="Follow @freesewing_org on Twitter"/>
+  </a></p>
+
+## What am I looking at? 🤔
+
+This repository is our *monorepo* holding [all our NPM packages](https://www.npmjs.com/search?q=keywords:freesewing).  
+This folder holds **@freesewing/plugin-notches**
+
+A FreeSewing plugin that provides front and back notch snippets
+
+
+
+## About FreeSewing 💀
+
+Where the world of makers and developers collide, that's where you'll find FreeSewing.
+
+Our [core library](https://freesewing.dev/reference/api/) is a *batteries-included* toolbox
+for parametric design of sewing patterns. It's a modular system (check our list
+of [plugins](https://freesewing.dev/reference/plugins/) and getting started is as simple as:
+
+```bash
+npm init freesewing-pattern
+```
+
+The [getting started](https://freesewing.dev/guides/getting-started/) section on [freesewing.dev](https://freesewing.dev/) is a good
+entrypoint to our documentation, but you'll find a lot more there, including
+our [API reference](https://freesewing.dev/reference/api/),
+as well as [our turorial](https://freesewing.dev/tutorials/pattern-design/),
+and [howtos](https://freesewing.dev/howtos/).
+
+If you're a maker, checkout [freesewing.org](https://freesewing/) where you can generate
+our sewing patterns adapted to your measurements.
+
+## Support FreeSewing: Become a patron 🥰
+
+FreeSewing is an open source project run by a community, 
+and financially supported by our patrons.
+
+If you feel what we do is worthwhile, you too 
+should [become a patron](https://freesewing.org/patrons/join).
+
+## Links 👩‍💻
+
+ - 💻 Makers website: [freesewing.org](https://freesewing.org)
+ - 💻 Developers website: [freesewing.dev](https://freesewing.dev)
+ - 💬 Chat: On Discord via [chat.freesewing.org](https://chat.freesewing.org/)
+ - 🐦 Twitter: [@freesewing_org](https://twitter.com/freesewing_org)
+ - 📷 Instagram: [@freesewing_org](https://instagram.com/freesewing_org)
+
+## License: MIT 🤓
+
+© [Joost De Cock](https://github.com/joostdecock).  
+See [the license file](https://github.com/freesewing/freesewing/blob/develop/LICENSE) for details.
+
+## Where to get help 🤯
+
+Our [chatrooms on Discord](https://chat.freesewing.org/) are the best place to ask questions,
+share your feedback, or just hang out.
+
+If you want to report a problem, please [create an issue](https://github.com/freesewing/freesewing/issues/new).

packages/plugin-notches/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@freesewing/plugin-notches",
+  "version": "2.10.8-rc.0",
+  "description": "A FreeSewing plugin that provides front and back notch snippets",
+  "author": "Joost De Cock <joost@decock.org> (https://github.com/joostdecock)",
+  "homepage": "https://freesewing.org/",
+  "repository": "github:freesewing/freesewing",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/freesewing/freesewing/issues"
+  },
+  "keywords": [
+    "freesewing",
+    "plugin",
+    "sewing pattern",
+    "sewing",
+    "design",
+    "parametric design",
+    "made to measure",
+    "diy",
+    "fashion"
+  ],
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "rollup -c",
+    "test": "echo \"plugin-notches: No tests configured. Perhaps you'd like to do this?\" && exit 0",
+    "pubtest": "npm publish --registry http://localhost:6662",
+    "pubforce": "npm publish",
+    "symlink": "mkdir -p ./node_modules/@freesewing && cd ./node_modules/@freesewing && ln -s -f ../../../* . && cd -",
+    "start": "rollup -c -w"
+  },
+  "peerDependencies": {
+    "@freesewing/core": "^2.10.8-rc.0"
+  },
+  "dependencies": {},
+  "devDependencies": {},
+  "files": [
+    "dist/*",
+    "README.md",
+    "package.json"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "tag": "next"
+  },
+  "engines": {
+    "node": ">=12.0.0",
+    "npm": ">=6"
+  },
+  "rollup": {
+    "exports": "default"
+  }
+}

packages/plugin-notches/rollup.config.js

@@ -0,0 +1,37 @@
+import resolve from '@rollup/plugin-node-resolve'
+import commonjs from '@rollup/plugin-commonjs'
+import json from '@rollup/plugin-json'
+import { terser } from 'rollup-plugin-terser'
+import peerDepsExternal from 'rollup-plugin-peer-deps-external'
+import { name, version, description, author, license, main, module, rollup } from './package.json'
+
+const output = [
+  {
+    file: main,
+    format: 'cjs',
+    sourcemap: true,
+    exports: rollup.exports
+  }
+]
+if (typeof module !== 'undefined')
+  output.push({
+    file: module,
+    format: 'es',
+    sourcemap: true
+  })
+
+export default {
+  input: 'src/index.js',
+  output,
+  plugins: [
+    peerDepsExternal(),
+    resolve({ modulesOnly: true }),
+    commonjs(),
+    json(),
+    terser({
+      output: {
+        preamble: `/**\n * ${name} | v${version}\n * ${description}\n * (c) ${new Date().getFullYear()} ${author}\n * @license ${license}\n */`
+      }
+    })
+  ]
+}

packages/plugin-notches/src/index.js

@@ -0,0 +1,17 @@
+import { version, name } from '../package.json'
+
+const notches =
+  '<g id="notch"><circle cy="0" cx="0" r="1.4" class="fill-note" /><circle cy="0" cx="0" r="2.8" class="note" /></g><g id="bnotch"><path d="M -1.1 -1.1 L 1.1 1.1 M 1.1 -1.1 L -1.1 1.1" class="note stroke-xl" /><circle cy="0" cx="0" r="2.8" class="note" /></g>'
+
+export default {
+  name: name,
+  version: version,
+  hooks: {
+    preRender: function (svg) {
+      if (svg.attributes.get('freesewing:plugin-notches') === false) {
+        svg.defs += notches
+        svg.attributes.add('freesewing:plugin-notches', version)
+      }
+    }
+  }
+}

packages/plugin-theme/src/defs/notch.js

@@ -1 +0,0 @@
-export default '<g id="notch"><circle cy="0" cx="0" r="1.4" class="fill-note" /><circle cy="0" cx="0" r="2.8" class="note" /></g><g id="bnotch"><path d="M -1.1 -1.1 L 1.1 1.1 M 1.1 -1.1 L -1.1 1.1" class="note stroke-xl" /><circle cy="0" cx="0" r="2.8" class="note" /></g>';

packages/plugin-theme/src/index.js

@@ -1,5 +1,4 @@
 import { version, name } from '../package.json'
-import notch from './defs/notch'
 import gridMetric from './defs/grid-metric'
 import gridImperial from './defs/grid-imperial'
 import css from './bundle.css.js'
@@ -8,10 +7,9 @@ export default {
   name: name,
   version: version,
   hooks: {
-    preRender: function(svg) {
+    preRender: function (svg) {
       if (svg.attributes.get('freesewing:plugin-theme') === false) {
         svg.attributes.set('class', 'freesewing')
-        svg.defs += notch
         svg.style += css
         if (svg.pattern.settings.paperless) {
           svg.pattern.settings.units === 'imperial'