e4035b2509
These are some changes in the way the monorepo is structured, that are aimed at making it easier to get started. There are two important changes: **Multiple workspaces** We had a yarn workspaces setup at `packages/*`. But our monorepo has grown to 92 packages which can be overwhelming for people not familiar with the package names. To remedy this, I've split it into 4 different workspaces: - `designs/*`: Holds FreeSewing designs (think patterns) - `plugins/*`: Holds FreeSewing plugins - `packages/*`: Holds other packages published on NPM - `sites/*`: Holds software that is not published as an NPM package, such as our various websites and backend API This should make it easier to find things, and to answer questions like *where do I find the code for the plugins*. **Updated reconfigure script to handle build order** One problem when bootstrapping the repo is inter-dependencies between packages. For example, building a pattern will only work once `plugin-bundle` is built. Which will only work once all plugins in the bundle or built. And that will only work when `core` is built, and so on. This can be frustrating for new users as `yarn buildall` will fail. And it gets overlooked by seasoned devs because they're likely to have every package built in their repo so this issue doesn't concern them. To remedy this, we now have a `config/build-order.mjs` file and the updated `/scripts/reconfigure.mjs` script will enforce the build order so that things *just work*.
1.4 KiB
1.4 KiB
Plugins
- plugin-cutonfold : Add cut-on-fold indicators to your patterns
- plugin-dimension : Add dimensions to your (paperless) patterns
- plugin-grainline : Add grainline indicators to your patterns
- plugin-logo : Add a scalebox to your patterns
- plugin-scalebox : Add pretty titles to your pattern parts
- plugin-title : Add pretty titles to your pattern parts
- plugin-round : Rounds corners
- plugin-sprinkle : Add multiple snippets to your pattern
Note that these are all build-time plugins. In other words, plugins used by developers/pattern designers, rather than run-time plugins that are used when generating patterns.
Without exception, all freesewing patterns use all these plugins, so it made sense to bundle them.
Usage
To load this plugin, add it to your instantiated pattern.
On node.js:
import freesewing from '@freesewing/core'
import plugins from '@freesewing/plugin-bundle'
let pattern = new freesewing.Pattern().with(plugins);