From 364e43b63501259224f0b852f0ed843418c80f10 Mon Sep 17 00:00:00 2001 From: Joost De Cock Date: Mon, 29 Aug 2022 11:54:21 +0200 Subject: [PATCH] breaking(config-helpers): Is now (again) the snapseries package --- CHANGELOG.md | 13 +++++----- config/changelog.yaml | 4 ++++ config/software/packages.json | 2 +- packages/config-helpers/CHANGELOG.md | 15 ------------ packages/snapseries/CHANGELOG.md | 15 ++++++++++++ .../{config-helpers => snapseries}/README.md | 24 +++++++++---------- .../{config-helpers => snapseries}/build.mjs | 0 .../package.json | 8 +++---- .../src/index.js => snapseries/src/index.mjs} | 21 ---------------- 9 files changed, 43 insertions(+), 59 deletions(-) delete mode 100644 packages/config-helpers/CHANGELOG.md create mode 100644 packages/snapseries/CHANGELOG.md rename packages/{config-helpers => snapseries}/README.md (98%) rename packages/{config-helpers => snapseries}/build.mjs (100%) rename packages/{config-helpers => snapseries}/package.json (81%) rename packages/{config-helpers/src/index.js => snapseries/src/index.mjs} (65%) diff --git a/CHANGELOG.md b/CHANGELOG.md index c0c33a5be78..830b4b8c260 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ - The `@freesewing/components` package is not part of FreeSewing v3. While v2 versions remain available, this package is no longer supported. - The `@freesewing/css-theme` package is not part of FreeSewing v3. While v2 versions remain available, this package is no longer supported. + - The `@freesewing/config-helpers` package is not part of FreeSewing v3. While v2 versions remain available, this package is no longer supported. Use the `@freesewing/snapseries` package for various helpers for snapped percentage options. The `pctBasedOn` helper method is now available as a named export from `@freesewing/core` - The `@freesewing/i18n` package is not part of FreeSewing v3. While v2 versions remain available, this package is no longer supported. - The `@freesewing/mui-theme` package is not part of FreeSewing v3. While v2 versions remain available, this package is no longer supported. - The `@freesewing/pattern-info` package is not part of FreeSewing v3. While v2 versions remain available, this package is no longer supported. @@ -840,12 +841,6 @@ - Migrated from Rollup to Esbuild for all builds -### config-helpers - -#### Added - - - This new package replaces the previous snapseries package and adds extra helper methods for pattern config such as `pctBasedOn()` which was previously exported by core - ### core #### Changed @@ -1922,6 +1917,12 @@ - This is a plugin to strip (FreeSewing) versdion info out of the SVG to allow you to diff your SVG output between FreeSewing versions - Initial release +### snapseries + +#### Added + + - Initial release of `@freesewing/snapseries` wich holds commonly used series of snap values for percentage options + ### core #### Added diff --git a/config/changelog.yaml b/config/changelog.yaml index b548c2c2945..72455def92a 100644 --- a/config/changelog.yaml +++ b/config/changelog.yaml @@ -14,6 +14,10 @@ Unreleased: While v2 versions remain available, this package is no longer supported. - The `@freesewing/css-theme` package is not part of FreeSewing v3. While v2 versions remain available, this package is no longer supported. + - The `@freesewing/config-helpers` package is not part of FreeSewing v3. + While v2 versions remain available, this package is no longer supported. + Use the `@freesewing/snapseries` package for various helpers for snapped percentage options. + The `pctBasedOn` helper method is now available as a named export from `@freesewing/core` - The `@freesewing/i18n` package is not part of FreeSewing v3. While v2 versions remain available, this package is no longer supported. - The `@freesewing/mui-theme` package is not part of FreeSewing v3. diff --git a/config/software/packages.json b/config/software/packages.json index 8835d393769..997efb4d0b7 100644 --- a/config/software/packages.json +++ b/config/software/packages.json @@ -1,5 +1,5 @@ { - "config-helpers": "A FreeSewing package to facilitate pattern configurations", + "snapseries": "A FreeSewing package to facilitate snapped percentage options in designs", "core": "A library for creating made-to-measure sewing patterns", "i18n": "Translations for the FreeSewing project", "models": "Body measurements data for a range of default sizes", diff --git a/packages/config-helpers/CHANGELOG.md b/packages/config-helpers/CHANGELOG.md deleted file mode 100644 index fea39b834db..00000000000 --- a/packages/config-helpers/CHANGELOG.md +++ /dev/null @@ -1,15 +0,0 @@ -# Change log for: @freesewing/config-helpers - - -## 2.21.0 (2022-06-27) - -### Added - - - This new package replaces the previous snapseries package and adds extra helper methods for pattern config such as `pctBasedOn()` which was previously exported by core - - -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. - diff --git a/packages/snapseries/CHANGELOG.md b/packages/snapseries/CHANGELOG.md new file mode 100644 index 00000000000..af8df329c2c --- /dev/null +++ b/packages/snapseries/CHANGELOG.md @@ -0,0 +1,15 @@ +# Change log for: @freesewing/snapseries + + +## 2.19.0 (2021-10-17) + +### Added + + - Initial release of `@freesewing/snapseries` wich holds commonly used series of snap values for percentage options + + +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. + diff --git a/packages/config-helpers/README.md b/packages/snapseries/README.md similarity index 98% rename from packages/config-helpers/README.md rename to packages/snapseries/README.md index 63807d62c55..fe59a8667a2 100644 --- a/packages/config-helpers/README.md +++ b/packages/snapseries/README.md @@ -1,13 +1,13 @@ ![FreeSewing](https://static.freesewing.org/banner.png)

@freesewing/config-helpers on NPM + href="https://www.npmjs.com/package/@freesewing/snapseries" + title="@freesewing/snapseries on NPM" + >@freesewing/snapseries on NPM License: MIT Code quality on DeepScan Open issues tagged pkg:config-helpers + href="https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Asnapseries" + title="Open issues tagged pkg:snapseries" + >Open issues tagged pkg:snapseries

-# @freesewing/config-helpers +# @freesewing/snapseries -A FreeSewing package to facilitate pattern configurations +A FreeSewing package to facilitate snapped percentage options in designs @@ -63,7 +63,7 @@ A FreeSewing package to facilitate pattern configurations This repository is our *monorepo* holding all our NPM designs, plugins, other NPM packages, and (web)sites. -This folder holds: @freesewing/config-helpers +This folder holds: @freesewing/snapseries If you're not entirely sure what to do or how to start, type this command: diff --git a/packages/config-helpers/build.mjs b/packages/snapseries/build.mjs similarity index 100% rename from packages/config-helpers/build.mjs rename to packages/snapseries/build.mjs diff --git a/packages/config-helpers/package.json b/packages/snapseries/package.json similarity index 81% rename from packages/config-helpers/package.json rename to packages/snapseries/package.json index 94c848e3714..6e630bdf8af 100644 --- a/packages/config-helpers/package.json +++ b/packages/snapseries/package.json @@ -1,7 +1,7 @@ { - "name": "@freesewing/config-helpers", + "name": "@freesewing/snapseries", "version": "3.0.0-alpha.0", - "description": "A FreeSewing package to facilitate pattern configurations", + "description": "A FreeSewing package to facilitate snapped percentage options in designs", "author": "Joost De Cock (https://github.com/joostdecock)", "homepage": "https://freesewing.org/", "repository": "github:freesewing/freesewing", @@ -27,11 +27,11 @@ "clean": "rimraf dist", "mbuild": "NO_MINIFY=1 node --experimental-json-modules build.mjs", "symlink": "mkdir -p ./node_modules/@freesewing && cd ./node_modules/@freesewing && ln -s -f ../../../* . && cd -", - "test": "echo \"config-helpers: No tests configured. Perhaps you'd like to do this?\" && exit 0", + "test": "echo \"snapseries: No tests configured. Perhaps you'd like to do this?\" && exit 0", "vbuild": "VERBOSE=1 node --experimental-json-modules build.mjs", "lab": "cd ../../sites/lab && yarn start", "tips": "node ../../scripts/help.mjs", - "cibuild_step0": "node --experimental-json-modules build.mjs" + "cibuild_step6": "node --experimental-json-modules build.mjs" }, "peerDependencies": {}, "dependencies": {}, diff --git a/packages/config-helpers/src/index.js b/packages/snapseries/src/index.mjs similarity index 65% rename from packages/config-helpers/src/index.js rename to packages/snapseries/src/index.mjs index 085d5b8254e..4523a17ae16 100644 --- a/packages/config-helpers/src/index.js +++ b/packages/snapseries/src/index.mjs @@ -1,8 +1,3 @@ - -/* - * Snap series - * ============================== - */ // Common width for elastics export const elastics = { metric: [3.5, 5, 10, 12, 20, 25, 30, 40, 50, 60, 80, 100, 120], @@ -38,21 +33,6 @@ export const bigsteps = { imperial: 12.7, // 1/2 inch } -/* - * Config helper methods - * ============================== - */ -export function pctBasedOn(measurement) { - return { - toAbs: (val, { measurements }) => measurements?.[measurement] - ? measurements[measurement] * val - : null, - fromAbs: (val, { measurements }) => measurements?.[measurement] - ? Math.round((10 * val) / measurements[measurement]) / 10 - : null - } -} - // Default export export default { elastics, @@ -60,5 +40,4 @@ export default { smallsteps, steps, bigsteps, - pctBasedOn, }