Skip to content

Latest commit

 

History

History
260 lines (140 loc) · 5.18 KB

MAINTENANCE.md

File metadata and controls

260 lines (140 loc) · 5.18 KB

Maintenance of the code

Commands

Run the unit tests with Jest

Run: npx baldrick-broth test jest

See also:

Run unit tests declaratively

Run unit tests for pure functions declaratively using YAML files

Motivation: Check that the units of code behave as intended

Run: npx baldrick-broth test spec

See also:

Run node.js unit tests

Run traditional unit tests

Motivation: Test what is not easily covered with zest

Run: npx baldrick-broth test unit

See also:

Run acceptance tests for the CLI

Run acceptance tests declaratively using YAML files

Motivation: Check that the CLI application behaves as intended

Run: npx baldrick-broth test pest

See also:

Run one acceptance tests for the CLI

Run one acceptance tests declaratively using YAML files

Motivation: Check that the CLI application behaves as intended

Run: npx baldrick-broth test pest1

See also:

Count lines of code

Count lines of code

Motivation: Count lines of code

Run: npx baldrick-broth test scc

See also:

Run client directly

Run the client with ts-node during development

Motivation: Simulate a CLI app in development without the need to install it globally

Run: npx baldrick-broth test cli

Transpile typescript

Generate javascript from the typescript source code

Motivation: Javascript code is more portable and can be consumed by other projects

Run: npx baldrick-broth transpile ts

See also:

Upgrade to latest dependencies

Upgrade to latest npm dependencies

Motivation: Keep up with security and improvements

Run: npx baldrick-broth deps upgrade

Generate documentation

Generate the markdown documentation for the typescript project

Motivation: Good documentation is essential for developer experience

Run: npx baldrick-broth doc ts

See also:

Standardize the github repository

Enable useful features for the github project repository

Motivation: Create consistent settings

Run: npx baldrick-broth github standard

Static code analysis of Typescript code

Find problems in Typescript code

Motivation: Make the code more consistent and avoid bugs

Run: npx baldrick-broth lint check

Fix static code analysis

Fix problems in Typescript code

Motivation: Facilitate routine maintenance of code

Run: npx baldrick-broth lint fix

Check Markdown files

Checks that the markdown documents follows some consistent guidelines

Motivation: Make the markdown documents consistent in style

Run: npx baldrick-broth md check

Fix Markdown files

Modify the markdown documents to ensure they follow some consistent guidelines

Motivation: Make the markdown documents consistent in style

Run: npx baldrick-broth md fix

Ready for publishing

Run a sequence of commands to check that the library is ready to be published

Motivation: Detect quality flaws before pushing the code

Run: npx baldrick-broth release ready

Pull request for the project

Create a pull request for the branch

Motivation: Automate the body of pull request

Run: npx baldrick-broth release pr

Publish the current library

Publih the current library to npm

Motivation: Detect quality flaws before pushing the code

Run: npx baldrick-broth release publish

Upgrade baldrick-broth configuration to latest version

Gets the latest version of this configuration file

Motivation: Always apply the latest project conventions

Run: npx baldrick-broth scaffold upgrade

Normalize the project

Normalize the project in a similar fashion that the other typescript projects

Motivation: Make the project structure consistent and easier to navigate

Run: npx baldrick-broth scaffold norm

Normalize the project

Normalize the project in a similar fashion that the other typescript projects

Motivation: Make the project structure consistent and easier to navigate

Run: npx baldrick-broth scaffold norm-package