Joost De Cock 1fd46554af 🔧 Switched to centrally managed README files

2019-04-19 20:09:30 +02:00

6.3 KiB

Raw Blame History

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 hellp in our chatroom on Gitter.

FreeSewing is a free and open source library for made-to-measure sewing patterns

@freesewing/plugin-validate

A FreeSewing plugin that validates aspects of your code

freesewing
^{a library for made-to-measure sewing patterns}

plugin-validate

A freesewing plugin that validates your pattern and input. It will check for:

Missing measurements that are required by the pattern
Missing X or Y coordinates in points
Points that aren't points or don't have proper attributes
Paths that don't do anything (no ops)
Paths that use points that aren't valid points
Text that will cause problems for translation

On any of these, this plugin will throw an error. As such, it's not meant to be used in production, but rather during pattern development, to spot issues in your code.

Usage

To load this plugin, add it to your instantiated pattern.

On node.js:

import pattern from '@freesewing/pattern-brian'
import validate from '@freesewing/plugin-validate'

pattern.with(validate);

In the browser, this plugin will register as freesewing.plugins.validate:

<script type="text/javascript" src="https://unpkg.com/freesewing"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-validate"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/pattern-brian"></script>

<script>
var pattern = freesewing.patterns.brian
  .with(freesewing.plugins.validate);
</script>

Install

To install, run:

npm install @freesewing/plugin-validate

License: MIT

See the license file for details.

About FreeSewing

Where the world of makers and developers collide, that's where you'll find FreeSewing.

Our core library is a batteries-included toolbox for parametric design of sewing patterns. It's a modular system (check our list of plugins and getting started is as simple as:

npm init freesewing-pattern

The [getting started] section on freesewing.dev is a good entrypoint to our documentation, but you'll find a lot more there, including our API documentation, as well as examples, and best practices.

If you're a maker, checkout freesewing.org 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.

6.3 KiB Raw Blame History