https://github.com/laudebugs/organize-codebase

Quickly organize your codebase with useful automation tools in development
https://github.com/laudebugs/organize-codebase

changelog commitizen commitlint eslint husky prettier semantic-release standard-version

Last synced: 15 days ago
JSON representation

Quickly organize your codebase with useful automation tools in development

• Host: GitHub
• URL: https://github.com/laudebugs/organize-codebase
• Owner: laudebugs
• Created: 2022-02-23T18:19:56.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T05:53:21.000Z (11 months ago)
• Last Synced: 2024-10-14T18:21:06.327Z (about 1 month ago)
• Topics: changelog, commitizen, commitlint, eslint, husky, prettier, semantic-release, standard-version
• Language: TypeScript
• Homepage:
• Size: 888 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md

Awesome Lists containing this project

README

        
Welcome to organize-codebase 👋




  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



> Quickly organize your codebase with useful automation tools in development

### 🏠 [Homepage](https://github.com/laudebugs/organize-codebase)

## Description

This Command Line Tool is useful to get up and running with the most common set ups when maintaining a JavaScript project. It handles setup of the following: 

- [`prettier`](https://prettier.io/) - formatting code

- [`eslint`](https://eslint.org/) - finds and fixes problems in your code

- [`commitlint`](https://commitlint.js.org/#/) - for linting commit messages

- [`commitizen`](http://commitizen.github.io/cz-cli/) - a cli tool to easily create good commit messages

- [`husky`](https://typicode.github.io/husky/#/) - enforces good commit messages/code formatting

- [`standard-version`](https://github.com/conventional-changelog/standard-version) or [`semantic-release`](https://semantic-release.gitbook.io/semantic-release/) - for npm packages

## Usage

As simple as running the following command within your project directory:

```sh

npx organize-codebase

```

## TODO

- [x] Add commit commands to scripts of `package.json`

- [x] Add semantic-release config to `package.json`

- [ ] Add ability to choose prettier format

- [ ] Merge config formats if config format is found in the project

- [ ] Add ability to add more ESLint plugins after setting up ESLint

## Author

👤 **Laurence B. Ininda**

* Website: https://laudebugs.me

* Twitter: [@laudebugs](https://twitter.com/laudebugs)

* Github: [@laudebugs](https://github.com/laudebugs)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/laudebugs/organize-codebase/issues). You can also take a look at the [contributing guide](https://github.com/laudebugs/organize-codebase/blob/master/docs/CONTRIBUTING.md).

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2022 [Laurence B. Ininda](https://github.com/laudebugs).


This project is [ISC](https://github.com/laudebugs/organize-codebase/blob/master/LICENSE) licensed.

***

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_