https://github.com/flarebyte/baldrick-ts
The typescript assistant with a cunning plan
https://github.com/flarebyte/baldrick-ts
npm-cli
Last synced: over 1 year ago
JSON representation
The typescript assistant with a cunning plan
- Host: GitHub
- URL: https://github.com/flarebyte/baldrick-ts
- Owner: flarebyte
- License: mit
- Created: 2021-07-08T21:34:57.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-06-14T08:29:58.000Z (almost 4 years ago)
- Last Synced: 2025-02-04T16:51:14.470Z (over 1 year ago)
- Topics: npm-cli
- Language: TypeScript
- Homepage:
- Size: 323 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Baldrick-ts
 
> Baldrick-ts is a Typescript assistant with a cunning plan that can be
> used for scaffolding
The main motivation is to streamline the development process for node.js
libraries and CLI written in Typescript. It supports the following features.
- **Typescript** the strongly typed alternative to Javascript.
- **ES2020** or later.
- [baldrick-dev-ts](https://github.com/flarebyte/baldrick-dev-ts) under
the hood linting and testing.
- **Standardized markdown docs** for maintenance and support.
- **Github workflow support** for continuous integration.
- **Visual Studio Code snippets** for common project suggestions.
## Usage
Generate and standardize the source code files
`baldrick-ts generate [options]`
- Options:
- `-f, --feature [feature...]` List of features (choices: "lib", "cli",
"gen")
- `-n, --name [name]` Name of the library
- `-ga, --github-account [githubAccount]` Github account
- `-ch, --copyright-holder [copyrightHolder]` The owner of the copyright
regarding the source code
- `-cy, --copyright-start-year [copyrightStartYear]` The year the project
has been started (default: "2021")
- `-l, --license [license]` Open source license if any (choices: "MIT",
"UNLICENSED", default: "MIT")
- `-b, --bin [bin]` The binary command used for calling the CLI
- `-h, --help` display help for command
## Documentation and links
- [Code Maintenance](MAINTENANCE.md)
- [Code Of Conduct](CODE_OF_CONDUCT.md)
- [Api for baldrick-ts](API.md)
- [Contributing](CONTRIBUTING.md)
- [Glossary](GLOSSARY.md)
- [Diagram for the code base](INTERNAL.md)
- [Vocabulary used in the code base](CODE_VOCABULARY.md)
- [Contributors](https://github.com/flarebyte/baldrick-ts/graphs/contributors)
- [Dependencies](https://github.com/flarebyte/baldrick-ts/network/dependencies)
## Installation
This package is [ESM
only](https://blog.sindresorhus.com/get-ready-for-esm-aa53530b3f77).
```bash
yarn global add baldrick-ts
baldrick-ts --help
```
Or alternatively run it:
```bash
npx baldrick-ts --help
```
If you want to tun the latest version from github. Mostly useful for dev:
```bash
git clone git@github.com:flarebyte/baldrick-ts.git
yarn global add `pwd`
```