✨ Added @freesewing/pattern-info
This commit is contained in:
Joost De Cock
parent
3c803b3257
commit
0c4187e12a
7 changed files with 363 additions and 0 deletions
1
packages/pattern-info/.gitignore
vendored
Normal file
1
packages/pattern-info/.gitignore
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
src/prebuild/
|
||||
148
packages/pattern-info/README.md
Normal file
148
packages/pattern-info/README.md
Normal file
|
|
@ -0,0 +1,148 @@
|
|||
> **Note**: This is part of version 2 of FreeSewing.
|
||||
> It is a work in progress, and not ready for prime-time yet
|
||||
>
|
||||
> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).
|
||||
|
||||
<p align="center"><a title="Go to freesewing.org" href="https://freesewing.org/"><img src="https://freesewing.org/img/logo/black.svg" align="center" width="150px" alt="Freesewing logo"/></a></p>
|
||||
<p align="center">FreeSewing is a free and open source library for made-to-measure sewing patterns</p>
|
||||
<p align='center'><a
|
||||
href="https://www.npmjs.com/package/@freesewing/pattern-info"
|
||||
title="@freesewing/pattern-info on NPM"
|
||||
><img src="https://img.shields.io/npm/v/freesewing.svg"
|
||||
alt="@freesewing/pattern-info on NPM"/>
|
||||
</a><a
|
||||
href="https://opensource.org/licenses/MIT"
|
||||
title="License: MIT"
|
||||
><img src="https://img.shields.io/npm/l/freesewing.svg?label=License"
|
||||
alt="License: MIT"/>
|
||||
</a><a
|
||||
href="https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Apattern-info"
|
||||
title="Open issues tagged pkg:pattern-info"
|
||||
><img src="https://img.shields.io/github/issues/freesewing/freesewing/pkg:pattern-info.svg?label=Issues"
|
||||
alt="Open issues tagged pkg:pattern-info"/>
|
||||
</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://gitter.im/freesewing/freesewing"
|
||||
title="Chat with us on Gitter"
|
||||
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Chat%20with%20us-CA0547.svg?logo=gitter&logoColor=white&logoWidth=15"
|
||||
alt="Chat with us on Gitter"/>
|
||||
</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>
|
||||
|
||||
# @freesewing/pattern-info
|
||||
|
||||
Information about available freesewing patterns
|
||||
|
||||
|
||||
## Included patterns
|
||||
|
||||
### Blocks
|
||||
|
||||
Blocks or slopers are basic patterns shapes that you can extend into fully detailed patterns.
|
||||
|
||||
- [brian](https://github.com/freesewing/brian) : A basic body block for menswear, and the basis for many of our menswear patterns.
|
||||
- [bent](https://github.com/freesewing/bent) : A version of [brian](https://github.com/freesewing/brian) with a two-part sleeve, and the and the basis of our menswear coat and jacket patterns.
|
||||
|
||||
### Menswear
|
||||
|
||||
- [aaron](https://github.com/freesewing/aaron) : A tank top or A-shirt
|
||||
- [bruce](https://github.com/freesewing/bruce) : Boxer briefs
|
||||
- [carlton](https://github.com/freesewing/carlton) : A long coat, perfect for Sherlock Holmes cosplay
|
||||
- [huey](https://github.com/freesewing/huey) : A zip-up hoodie
|
||||
- [hugo](https://github.com/freesewing/hugo) : A hooded sweatshirt with raglan sleeves
|
||||
- [jaeger](https://github.com/freesewing/jaeger) : A sportscoat
|
||||
- [simon](https://github.com/freesewing/simon) : A versatile button-down shirt
|
||||
- [sven](https://github.com/freesewing/sven) : A straightforward sweater
|
||||
- [wahid](https://github.com/freesewing/wahid) : A classic waistcoat
|
||||
|
||||
|
||||
### Womenswear
|
||||
|
||||
- [cathrin](https://github.com/freesewing/cathrin) : An underbust corset or waist trainer
|
||||
- [tamiko](https://github.com/freesewing/tamiko) : A zero-waste top
|
||||
|
||||
### Accessories
|
||||
|
||||
- [trayvon](https://github.com/freesewing/trayvon) : A (neck) tie
|
||||
|
||||
> #### Note: menswear/womenswear has nothing to do with gender
|
||||
>
|
||||
> Freesewing is gender-neutral. When we use the terms **menswear** or **womenswear**
|
||||
> we are not talking about clothes for men or women. It is merely a category of clothing
|
||||
> much like **accessories** or **shoes** are categories.
|
||||
>
|
||||
> The category gives you an idea what to expect, and is there to help you find things.
|
||||
> It is not a limitation, or even a suggestion, of what you can or should wear or make.
|
||||
>
|
||||
> Wear whatever you want, and be proud of the things you make.
|
||||
|
||||
## Usage
|
||||
|
||||
This package has 2 exports:
|
||||
|
||||
- `patterns` : (the default export) An object holding pattern constructors
|
||||
- `patternList` : An array of pattern names
|
||||
|
||||
|
||||
|
||||
## About FreeSewing 🤔
|
||||
|
||||
Where the world of makers and developers collide, that's where you'll find FreeSewing.
|
||||
|
||||
Our [core library](https://freesewing.dev/en/freesewing) is a *batteries-included* toolbox
|
||||
for parametric design of sewing patterns. It's a modular system (check our list
|
||||
of [plugins](https://freesewing.dev/en/plugins) and getting started is as simple as:
|
||||
|
||||
```bash
|
||||
npm init freesewing-pattern
|
||||
```
|
||||
|
||||
The [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 documentation](https://freesewing.dev/en/freesewing/api),
|
||||
as well as [examples](https://freesewing.dev/en/freesewing/examples),
|
||||
and [best practices](https://freesewing.dev/en/do).
|
||||
|
||||
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.org)
|
||||
- 💬 Chat: [gitter.im/freesewing](https://gitter.im/freesewing/freesewing)
|
||||
- 🐦 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 [chatroom on Gitter](https://gitter.im) is 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).
|
||||
50
packages/pattern-info/info.md
Normal file
50
packages/pattern-info/info.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
|
||||
## Included patterns
|
||||
|
||||
### Blocks
|
||||
|
||||
Blocks or slopers are basic patterns shapes that you can extend into fully detailed patterns.
|
||||
|
||||
- [brian](https://github.com/freesewing/brian) : A basic body block for menswear, and the basis for many of our menswear patterns.
|
||||
- [bent](https://github.com/freesewing/bent) : A version of [brian](https://github.com/freesewing/brian) with a two-part sleeve, and the and the basis of our menswear coat and jacket patterns.
|
||||
|
||||
### Menswear
|
||||
|
||||
- [aaron](https://github.com/freesewing/aaron) : A tank top or A-shirt
|
||||
- [bruce](https://github.com/freesewing/bruce) : Boxer briefs
|
||||
- [carlton](https://github.com/freesewing/carlton) : A long coat, perfect for Sherlock Holmes cosplay
|
||||
- [huey](https://github.com/freesewing/huey) : A zip-up hoodie
|
||||
- [hugo](https://github.com/freesewing/hugo) : A hooded sweatshirt with raglan sleeves
|
||||
- [jaeger](https://github.com/freesewing/jaeger) : A sportscoat
|
||||
- [simon](https://github.com/freesewing/simon) : A versatile button-down shirt
|
||||
- [sven](https://github.com/freesewing/sven) : A straightforward sweater
|
||||
- [wahid](https://github.com/freesewing/wahid) : A classic waistcoat
|
||||
|
||||
|
||||
### Womenswear
|
||||
|
||||
- [cathrin](https://github.com/freesewing/cathrin) : An underbust corset or waist trainer
|
||||
- [tamiko](https://github.com/freesewing/tamiko) : A zero-waste top
|
||||
|
||||
### Accessories
|
||||
|
||||
- [trayvon](https://github.com/freesewing/trayvon) : A (neck) tie
|
||||
|
||||
> #### Note: menswear/womenswear has nothing to do with gender
|
||||
>
|
||||
> Freesewing is gender-neutral. When we use the terms **menswear** or **womenswear**
|
||||
> we are not talking about clothes for men or women. It is merely a category of clothing
|
||||
> much like **accessories** or **shoes** are categories.
|
||||
>
|
||||
> The category gives you an idea what to expect, and is there to help you find things.
|
||||
> It is not a limitation, or even a suggestion, of what you can or should wear or make.
|
||||
>
|
||||
> Wear whatever you want, and be proud of the things you make.
|
||||
|
||||
## Usage
|
||||
|
||||
This package has 2 exports:
|
||||
|
||||
- `patterns` : (the default export) An object holding pattern constructors
|
||||
- `patternList` : An array of pattern names
|
||||
|
||||
50
packages/pattern-info/package.json
Normal file
50
packages/pattern-info/package.json
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
{
|
||||
"name": "@freesewing/pattern-info",
|
||||
"version": "2.0.0-alpha.3",
|
||||
"description": "Information about available freesewing patterns",
|
||||
"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",
|
||||
"design",
|
||||
"diy",
|
||||
"fashion",
|
||||
"made to measure",
|
||||
"parametric design",
|
||||
"sewing"
|
||||
],
|
||||
"main": "dist/index.js",
|
||||
"module": "dist/index.mjs",
|
||||
"scripts": {
|
||||
"clean": "rimraf dist",
|
||||
"nodebuild": "BABEL_ENV=production rollup -c -o dist/index.js -f cjs",
|
||||
"modulebuild": "BABEL_ENV=production rollup -c -o dist/index.mjs -f es",
|
||||
"build": "npm run clean && npm run nodebuild && npm run modulebuild",
|
||||
"test": "echo \"pattern-info: 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 -",
|
||||
"prebuild": "node src/prebuild.js"
|
||||
},
|
||||
"peerDependencies": {},
|
||||
"dependencies": {},
|
||||
"devDependencies": {},
|
||||
"files": [
|
||||
"dist/*",
|
||||
"README.md",
|
||||
"package.json"
|
||||
],
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"tag": "alpha"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=8.0.0",
|
||||
"npm": ">=5"
|
||||
}
|
||||
}
|
||||
48
packages/pattern-info/rollup.config.js
Normal file
48
packages/pattern-info/rollup.config.js
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
import babel from "rollup-plugin-babel";
|
||||
import resolve from "rollup-plugin-node-resolve";
|
||||
import commonjs from "rollup-plugin-commonjs";
|
||||
import json from "rollup-plugin-json";
|
||||
import minify from "rollup-plugin-babel-minify";
|
||||
import yaml from "rollup-plugin-yaml";
|
||||
import url from "rollup-plugin-url";
|
||||
import postcss from "rollup-plugin-postcss";
|
||||
import svgr from "@svgr/rollup";
|
||||
import peerDepsExternal from "rollup-plugin-peer-deps-external";
|
||||
import { name, version, description, author, license } from "./package.json";
|
||||
|
||||
export default {
|
||||
input: "src/index.js",
|
||||
output: [
|
||||
{
|
||||
file: "dist/index.js",
|
||||
format: "cjs",
|
||||
sourcemap: true
|
||||
},
|
||||
{
|
||||
file: "dist/index.mjs",
|
||||
format: "es",
|
||||
sourcemap: true
|
||||
}
|
||||
],
|
||||
plugins: [
|
||||
peerDepsExternal(),
|
||||
resolve({ modulesOnly: true }),
|
||||
url(),
|
||||
commonjs(),
|
||||
json(),
|
||||
yaml(),
|
||||
svgr(),
|
||||
postcss({
|
||||
modules: true
|
||||
}),
|
||||
babel({
|
||||
exclude: "node_modules/**",
|
||||
plugins: ["@babel/plugin-proposal-object-rest-spread"]
|
||||
}),
|
||||
minify({
|
||||
comments: false,
|
||||
sourceMap: true,
|
||||
banner: `/**\n * ${name} | v${version}\n * ${description}\n * (c) ${new Date().getFullYear()} ${author}\n * @license ${license}\n */`
|
||||
})
|
||||
]
|
||||
};
|
||||
22
packages/pattern-info/src/index.js
Normal file
22
packages/pattern-info/src/index.js
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
import options from "./prebuild/options";
|
||||
import optionGroups from "./prebuild/option-groups";
|
||||
import versions from "./prebuild/versions";
|
||||
|
||||
const list = [
|
||||
"aaron",
|
||||
"bent",
|
||||
"brian",
|
||||
"bruce",
|
||||
"carlton",
|
||||
"cathrin",
|
||||
"huey",
|
||||
"hugo",
|
||||
"jaeger",
|
||||
"simon",
|
||||
"sven",
|
||||
"tamiko",
|
||||
"trayvon",
|
||||
"wahid"
|
||||
];
|
||||
|
||||
export { list, options, optionGroups, versions };
|
||||
44
packages/pattern-info/src/prebuild.js
Normal file
44
packages/pattern-info/src/prebuild.js
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
const path = require("path");
|
||||
const fse = require("fs-extra");
|
||||
const patterns = require("@freesewing/patterns").default;
|
||||
|
||||
const patternOptions = pattern => {
|
||||
let all = [];
|
||||
let groups = pattern.optionGroups;
|
||||
for (let group of Object.keys(groups)) {
|
||||
for (let option of groups[group]) {
|
||||
if (typeof option === "string") all.push(option);
|
||||
else {
|
||||
for (let subgroup of Object.keys(option)) {
|
||||
for (let suboption of option[subgroup]) all.push(suboption);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return all;
|
||||
};
|
||||
|
||||
let options = {};
|
||||
let optionGroups = {};
|
||||
let versions = {};
|
||||
for (let pattern of Object.keys(patterns)) {
|
||||
let instance = new patterns[pattern]();
|
||||
let p = pattern.toLowerCase();
|
||||
options[p] = patternOptions(instance.config);
|
||||
optionGroups[p] = instance.config.optionGroups;
|
||||
versions[p] = instance.config.version;
|
||||
}
|
||||
|
||||
fse.writeFileSync(
|
||||
path.join(".", "src", "prebuild", "options.js"),
|
||||
"module.exports = " + JSON.stringify(options) + "\n"
|
||||
);
|
||||
fse.writeFileSync(
|
||||
path.join(".", "src", "prebuild", "option-groups.js"),
|
||||
"module.exports = " + JSON.stringify(optionGroups) + "\n"
|
||||
);
|
||||
fse.writeFileSync(
|
||||
path.join(".", "src", "prebuild", "versions.js"),
|
||||
"module.exports = " + JSON.stringify(versions) + "\n"
|
||||
);
|
||||
Loading…
Add table
Add a link
Reference in a new issue