javascript

JavaScript language plugin for the @form8ion toolset

Table of Contents

• Usage
  • Installation
  • Example
    • Import
    • Execute
  • Documentation
• Contributing
  • Dependencies
  • Verification

Usage

Installation

$ npm install @form8ion/javascript --save

Example

Import

const{dialects, projectTypes}=awaitimport('@form8ion/javascript-core');const{scaffold: scaffoldJavaScript,lift: liftJavascript,test: thisIsAJavaScriptProject,
scaffoldUnitTesting,
questionNames
}=awaitimport('./lib/index.js');

Execute

constaccountName='form8ion';constprojectRoot=process.cwd();awaitscaffoldJavaScript({
projectRoot,projectName: 'project-name',visibility: 'Public',license: 'MIT',configs: {eslint: {scope: `@${accountName}`},remark: `@${accountName}/remark-lint-preset`,babelPreset: {name: `@${accountName}`,packageName: `@${accountName}/babel-preset`},commitlint: {name: `@${accountName}`,packageName: `@${accountName}/commitlint-config`}},plugins: {unitTestFrameworks: {},applicationTypes: {},packageTypes: {},packageBundlers: {},ciServices: {}},decisions: {[questionNames.DIALECT]: dialects.BABEL,[questionNames.NODE_VERSION_CATEGORY]: 'LTS',[questionNames.PACKAGE_MANAGER]: 'npm',[questionNames.PROJECT_TYPE]: projectTypes.PACKAGE,[questionNames.SHOULD_BE_SCOPED]: true,[questionNames.SCOPE]: accountName,[questionNames.AUTHOR_NAME]: 'Your Name',[questionNames.AUTHOR_EMAIL]: 'you@domain.tld',[questionNames.AUTHOR_URL]: 'https://your.website.tld',[questionNames.UNIT_TESTS]: true,[questionNames.INTEGRATION_TESTS]: true,[questionNames.PROVIDE_EXAMPLE]: true}});if(awaitthisIsAJavaScriptProject({projectRoot})){awaitliftJavascript({
projectRoot,configs: {eslint: {scope: '@foo'}},results: {dependencies: {javascript: {production: [],development: []}},scripts: {},eslint: {configs: [],ignore: {directories: []}},packageManager: 'npm'},enhancers: {PluginName: {test: ()=>true,lift: ()=>({})}}});}awaitscaffoldUnitTesting({projectRoot: process.cwd(),frameworks: {Mocha: {scaffold: options=>options},Jest: {scaffold: options=>options}},visibility: 'Public',vcs: {host: 'GitHub',owner: 'foo',name: 'bar'},decisions: {[questionNames.UNIT_TEST_FRAMEWORK]: 'Mocha'}});

Documentation

• API
• Constants

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test