Terminology

The definitions used in this document describe how these concepts work as it relates to toolkit projects.

• Terms
  • boilerplate
  • component
  • config
  • config file
  • generator
  • init
  • scaffold
  • snippet
  • task
  • template
• Add a term
• Author
• License

(TOC generated by verb using markdown-toc)

Terms

boilerplate

Typically, the term boilerplate refers to generic code that is often used when creating projects. Here, we use the term to decribe "boilerplate configurations", which consist of all of the necessary files required to initialize a complete project. Boilerplates can be used by generators to create new projects.

Related words: init, scaffold, snippet, template

config

Typically used to describe a declarative configuration, consisting of files definitions (src glob patterns, dest directory, and so on), but also sometimes used to describe an options object.

config file

A named file, like gulpfile.js, verbfile.js, or generator.js, that contains custom configuration settings and runtime code for the associated application.

init

To initialize or create a new project.

Related projects: generate

scaffold

Consists of one or more templates or source files and serves as a "temporary support structure" that may be used to initialize a new project, or to provide ad-hoc "components" throughout the duration of a project.

Related words: boilerplate, snippet, template

snippet

Related words: boilerplate, scaffold, template

task

An asynchronous function that wraps code to be executed at a later, pre-determined point.

template

Resuable file, code or content that contains "placeholder" values, which will eventually be replaced with real values by a rendering (template) engine

Related words: boilerplate, scaffold, snippet

Related projects: templates

Add a term

1. clone - Clone this repository: git clone https://github.com/node-toolkit/terminology.git
2. add new term - Add the new term to terminology.yml using the conventions and formatting defined in .editorconfig.
3. build readme - If you already have verb#dev installed globally, just run verb. Otherwise, run the following command: npm run install && verb.
4. submit PR - Submit a [Pull Request](#Pull Request) with the title: new term: * where * is the name of the term.

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on March 02, 2018.