Skip to content

Latest commit

 

History

History
116 lines (75 loc) · 7.01 KB

README.md

File metadata and controls

116 lines (75 loc) · 7.01 KB

meta

introduction to the organization and cross-repo issues

Node CI Workflow Status

Goals of this Organization

The projects under this organization (as well as some yet to be migrated from my personal account) are mostly a codification of decisions I've made over time around how I prefer projects to be configured and organized. This helps me keep my projects consistent and also greatly reduces the burden of remembering or making fresh decisions for each new project.

This was created to make my life easier, but the tools are configurable for various contexts. I do have additional configurability in mind for future evolution, but if making something more configurable would make things easier for you, please open an issue so we can discuss. I may be hesitant to accept changes that aren't helpful to me, but I'm always open to at least discussing.

Usage

MIT license

Prerequisites

CLI Wrapper

Theses are intended to be run from your own CLI, so they provide only a programmatic interface that can be imported into your existing tool.

If you need to create a new CLI tool, you can refer to my commander instance or the form8ion yargs instance. oclif is also worth considering, but I personally have not tried that framework yet.

Project Scaffolding

The project scaffolding tools make it easy to create a new project using the structure that I've found to work well.

Within your CLI, start by adding the project-scaffolder as a sub-command. Here, you can configure your personal or organizational details and include other supporting scaffolder plugins.

Lifting Existing Projects

While codification of decisions can be a big help for improving consistency of projects, conventions do change over time. Projects that were created at an earlier point in time have likely drifted away from the current conventions.

lift intends to improve this situation by applying codified decisions to existing projects to update key details to align with current conventions. The lift tool can be added as an additional sub-command to your CLI.

Contributing to this Documentation

Conventional Commits Commitizen friendly PRs Welcome Renovate

Dependencies

$ nvm install
$ npm install

Verification

$ npm test