https://github.com/pacifiquem/lepper
Git-like project describer 📂
https://github.com/pacifiquem/lepper
lepper project-structure projects
Last synced: 10 months ago
JSON representation
Git-like project describer 📂
- Host: GitHub
- URL: https://github.com/pacifiquem/lepper
- Owner: pacifiquem
- License: mit
- Created: 2022-12-27T15:37:40.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-12T11:04:31.000Z (about 1 year ago)
- Last Synced: 2025-03-26T11:42:08.648Z (12 months ago)
- Topics: lepper, project-structure, projects
- Language: TypeScript
- Homepage: https://npmjs.com/package/lepper
- Size: 212 KB
- Stars: 40
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Lepper
Understand any project's structure easily.
## Description
Lepper can be used by big projects to let people understand how the project is structured.
With a few commands you can set/get a brief description of a project's structure and also find part of your project which is not described.
## Installation
```bash
npm install --save-dev lepper
```
## Usage
We offer 4 commands that can help to achieve what's described above:
- ``lepper init`` : Initialize *lepper* in your project.
- ``lepper profile`` : Set description to a directory.
- ``lepper describe`` : Provides brief description of the project's directories.
- ``lepper verify`` : Recursively checks and list undescribed directories.
## Contributing
If you want to contribute please refer to [CONTRIBUTING.md](https://github.com/pacifiquem/lepper/blob/main/CONTRIBUTING.md)
## License
This project is under [MIT](https://github.com/pacifiquem/lepper/blob/main/LICENSE).
## Maintainers
It was written by [@pacifiquem](https://github.com/pacifiquem) and he's the current maintainer.