opinionated scaffolder for new projects
README.md
$ npm install @form8ion/project --save-prod
This scaffolder is intended to be used as a CLI tool, but it is left up to the consumer to provide the actual CLI wrapper. My sub-command for commander is an example of such a wrapper.
import {lift, questionNames, scaffold} from '@form8ion/project';
await scaffold({
decisions: {
[questionNames.PROJECT_NAME]: 'my-project',
[questionNames.LICENSE]: 'MIT',
[questionNames.VISIBILITY]: 'Public',
[questionNames.DESCRIPTION]: 'My project',
[questionNames.GIT_REPO]: false,
[questionNames.COPYRIGHT_HOLDER]: 'John Smith',
[questionNames.COPYRIGHT_YEAR]: '2022',
[questionNames.PROJECT_LANGUAGE]: 'foo'
},
plugins: {
dependencyUpdaters: {
bar: {scaffold: options => options}
},
languages: {
foo: {scaffold: options => options}
},
vcsHosts: {
baz: {
scaffold: options => options,
prompt: () => ({repoOwner: 'form8ion'})
}
}
}
});
await lift({
projectRoot: process.cwd(),
results: {},
enhancers: {foo: {test: () => true, lift: () => ({})}},
vcs: {}
});
This is an opinionated scaffolder, but there are some aspects that are configurable in order to support multiple contexts.
Takes a single options object as an argument, containing:
languages
(optional)provides the languages to choose from and the functions to perform the
scaffolding for the chosen language. if no languages are provided, Other
will
be the only choice presented. Choosing Other
will perform no language-specific
scaffolding. Official options are provided in the awesome list.
object:
projectRoot
: string path of the working directory where the CLI
command was executedprojectName
: string name chosen for the project. defaults to the
directory name.vcs
: object details about the VCS
host
host
: string host namename
: string repository name. equal to projectName
owner
: string account name on the host service for the repository
owner. defaults to $ git config github.user
visibility
: string Public
or Private
. defaults to Private
license
: string identifier of the chosen SPDX License
or UNLICENSED
ci
: string name of the chosen CI service. defaults to Travis
description
: string short summary of the projectvcsHosts
(optional)provides the vcs hosts to choose from and the functions to perform the
scaffolding for the chosen host. if no hosts are provided, Other
will be the
only choice presented. Choosing Other
will perform no host-specific
scaffolding. Official options are provided in the awesome list.
object:
prompt
: function (required) prompts for host specific detailsrepoOwner
scaffolder
: function (required) scaffolds the host optionshost
: string name of the chosen host, as provided in the key of
the vcsHosts
objectname
: string name chosen for the project. defaults to the
directory name.owner
: the account name of the owner of the repo on the host, as
returned from the prompt
functionprojectRoot
: string path of the working directory where the CLI
command was executeddescription
: string brief summary of the projecthomepage
: string url of the project homepagepublic
: boolean (optional) whether this host should be presented
as a public optionprivate
: boolean (optional) whether this host should be presented
as a private optiondependencyUpdaters
(optional)provides the dependency updaters to choose from and the functions to perform the
scaffolding for the chosen updater service. if no updater services are provided,
Other
will be the only choice presented. Choosing Other
will perform no
updater-service-specific scaffolding. Official options are provided in the awesome list.
object:
scaffolder
: function (required) scaffolds the host optionsprojectRoot
: string path of the working directory where the CLI
command was executedvcs
: object details about the VCS
host
host
: string host namename
: string repository name. equal to projectName
owner
: string account name on the host service for the repository
owner. defaults to $ git config github.user
$ nvm install
$ npm install
$ npm test