@namics/blueprint
v0.1.2
Published
Create blueprints and use them in you project to create components, packages ...
Downloads
5
Keywords
Readme
Blueprint
Create blueprints and use them in you project to create components, packages ...
Install
npm i -D @namics/blueprint
Usage
.blueprintrc.js
module.exports = {
'react-app': {
title: 'Create a new react app',
src: './demo/test-package/example-app.zip',
},
};
interface IBlueprintrc {
[key: string]: {
title: string;
src: string;
overrideDestination?: () => string,
additionalQuestions?: (answers: { inquirer.Answers }) => Promise<inquirer.Questions>,
collectResult?: (answers: inquirer.Answers) => inquirer.Answers,
getCustomReplacements?: (answers: inquirer.Answers) => string[][],
}
}
API
import blueprint from '@namics/blueprint';
blueprint('react-app', {
srcFilePath: path.resolve(process.cwd(), 'blueprints', 'example-app.zip'),
targetPath: path.resolve(process.cwd(), 'packages'),
oldName: 'example-app',
newName: 'awesome-app',
customReplacements: [['BEM-placeholder', 'a']],
});
srcFilePath
: path to zip filetargetPath
: path in which the new app/component/* should be createdoldName
: old name is usually the filenamenewName
: the name of the app/component/*customReplacements
: define custom replacements forEach file data replacement
CLI
$ blueprint --value awesome-app --blueprint react-app --config .blueprintrc.js --destination packages
Options
-i
, --interactive
Use interactive command line user interface
-b
, --blueprint
The blueprint which should be used
-v
, --value
Name of the app/component/* which should be created
-d
, --destination
Destination path
-c
, --config
Path to config js file