Name: builder-support
Owner: Formidable
Description: Builder support libraries
Created: 2015-12-11 22:35:47.0
Updated: 2017-02-02 17:45:30.0
Pushed: 2017-09-25 20:02:27.0
Homepage: null
Size: 42
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Support tools for authoring builder archetypes.
To use the production and development workflows, install both this package and the development module:
m install --save-dev builder-support
Use this tool to create an ARCHETYPE-dev
module for publishing alongside
ARCHETYPE
with the same version numbers, details, etc.
This tools assumes an archetype structure of:
package.json
- Dependencies needed for production tasks and scripts
entry
that has tasks for both production and development. Must have name
,
description
fields.dev/package.json
../ARCHETYPE-dev/package.json
Assuming those exist, then the tool:
Modifies ARCHETYPE-dev/package.json
as follows:
package.json
package.json:devDependencies
package.json:dependencies
with
ARCHETYPE-dev/package.json:dependencies
name
field to represent ARCHETYPE-dev
Copies README.md
to ARCHETYPE-dev/README.md
Copies .gitignore
to ARCHETYPE-dev/.gitignore
This supports a workflow as follows:
m HISTORY.md # Version notes
m package.json # Bump version
ilder-support gen-dev # Generate `ARCHETYPE-dev` files
m run builder:check # Last check!
t add .
t commit -m "Version bump"
t tag -a "vNUMBER" -m "Version NUMBER"
t push && git push --tags
m publish # Publish main project
blish dev project in same repo
dev && npm publish
R) Publish dev project in different, parallel repo
../ARCHETYPE-dev
t commit -m "Version bump"
t tag -a "vNUMBER" -m "Version NUMBER"
t push && git push --tags
m publish # Publish dev project
If you are bootstrapping a new archetype you will need to ensure either that
a ARCHETYPE/dev
or ../ARCHETYPE-dev
directory exists. The rest of the files
when then be properly generated into the dev project.
And you should be good to run builder-support gen-dev
in the project root.