pkode

Table of Contents

• pkode
  • Table of Contents
  • About pkode
    • The problem
    • This solution
  • Inspiration
    • Why pkode name?
  • Installation
  • Usage
  • More References
    • Guidelines
      • Values
      • How to set up a new project
      • Running this package from the source code
      • Releasing this package manually
    • Contributing
  • Contributors ✨

About pkode

The problem

I open-source projects and want to make it easier to scaffold and maintain them.

This solution

This package is a CLI that abstracts away all configuration for my open source projects for linting, testing, building, and more.

Inspiration

This tool is inspired by react-scripts and kcd-scripts.

Why pkode name?

pkode is a short form of my pen name, Pejuang Kode.

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:

npm install --save-dev pkode

Usage

This is a CLI and exposes a bin called pkode. I don't plan on documenting or testing it super-duper well because it's really specific to my needs. You'll find all available scripts in src/scripts.

This project tries to dogfoods itself. If you look in the package.json, you'll find scripts with node src {scriptName}. This serves as an example of some of the things you can do with pkode.

More References

Not all of my implementation standards can be automated through scripts due to certain reasons, such as the deprecation of conventional JS config in husky.

Therefore, I complement this repository with some guidelines and how-tos that all contributors to my open-source projects can follow.

Guidelines

Values

As guidance in making decisions, we hold on to some values here that we adopted from WargaBantuWarga principles.

How to set up a new project

When setting up a new project, please follow these guidelines to ensure that it complies with our standards of quality.

Running this package from the source code

To run this package from the source code while developing and debugging pkode, you can use this command:

npm run ts src <script-name>

Releasing this package manually

Please follow the Manual Releases document to perform releases manually when things get messed up.

Contributing

See our contribution guidelines in these languages:

• English
• Indonesian

To facilitate healthy and constructive community behavior, we adopt and enforce Contributor Covenant Code of Conduct

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Zain Fathoni 📖 🚇

This project follows the all-contributors specification. Contributions of any kind are welcome!