Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ipetinate/clingon

Create components, functions, pages, and other files for your project with a few commands
https://github.com/ipetinate/clingon

cli developer-tools devexp devtools generator nodejs react tailwindcss tool vue

Last synced: about 1 month ago
JSON representation

Create components, functions, pages, and other files for your project with a few commands

Host: GitHub
URL: https://github.com/ipetinate/clingon
Owner: ipetinate
Created: 2024-04-07T21:54:11.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-05-22T11:50:12.000Z (6 months ago)
Last Synced: 2024-05-22T14:35:21.087Z (6 months ago)
Topics: cli, developer-tools, devexp, devtools, generator, nodejs, react, tailwindcss, tool, vue
Language: JavaScript
Homepage: https://www.clingon.dev/
Size: 901 KB
Stars: 10
Watchers: 2
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        


    

      

    



[![Build CI](https://github.com/ipetinate/clingon/actions/workflows/node.js.yml/badge.svg?branch=main)](https://github.com/ipetinate/clingon/actions/workflows/node.js.yml)

[![Release CI](https://github.com/ipetinate/clingon/actions/workflows/release.yml/badge.svg)](https://github.com/ipetinate/clingon/actions/workflows/release.yml)

[![Coverage Status](https://img.shields.io/coverallsCoverage/github/ipetinate/clingon?branch=main&logo=coveralls&label=Coverage)](https://coveralls.io/repos/github/ipetinate/clingon/badge.svg?branch=main)

[![Website](https://img.shields.io/website?url=https%3A%2F%2Fclingon.dev&logo=nextra&label=clingon.dev)](https://clingon.dev)

[![GitHub Release Date](https://img.shields.io/github/release-date/ipetinate/clingon?display_date=published_at&logo=npm&label=Release%20Date&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fclingon)](https://www.npmjs.com/package/clingon)

[![GitHub Release version](https://img.shields.io/github/v/release/ipetinate/clingon?display_name=release&logo=github&label=Release%20version)](https://github.com/ipetinate/clingon/releases)

[![NPM Version](https://img.shields.io/npm/v/clingon?logo=npm&label=NPM%20version)](https://www.npmjs.com/package/clingon)

# Clingon CLI

> Create components, functions, pages, and other files for your project with a few commands

Tired of creating components by hand? And still without any help from the VS Code interface or other IDEs?

Clingon comes to simplify this creation flow.

You are going to create a React or Vue component, but this component needs a test file and a stories file (if you use storybook), with its entire structure being grouped or separated, it is a very tiring task to create all of this, add the code boilerplate (which I know you will copy from another ready-made file and change everything).

Let's simplify all of this, execute a command, answer some questions, or select your favorite template and that's it, everything is created, just start coding.

## Links



  🔗 Official website 🔗



- Releases

  - [CHANGELOG](https://github.com/ipetinate/clingon/blob/main/CHANGELOG.md)

- Documentation

  - [Development Guide](https://github.com/ipetinate/clingon/blob/main/doc/DEVELOPMENT_README.md)

  - [Contribution Guide](https://github.com/ipetinate/clingon/blob/main/doc/CONTRIBUTION_GUIDE.md)

  - [Templates Variants](https://github.com/ipetinate/clingon/blob/main/doc/TEMPLATES.md)

  - [Development Taks](https://github.com/ipetinate/clingon/blob/main/doc/TASKS.md)

## Description

Clingon is a command line tool that helps you create files for your project.

By default, it already comes with some settings, which are commonly used concepts, and can offer you some known folder paths for common files, or ask you if you use TypeScript, what is the postfix for your test files, among other features that will help you be productive.

Answer a questionnaire with a few questions in guided mode (if you don't know exactly what you want, or if you're a beginner and need the code ready to start coding), or use advanced mode by selecting custom models that you created and added to the root of your project.

## How to use

Install the tool globally using your preferred Node package manager, or use `npx` to run the executable.

Note: Maybe on macOS you do not have permission to run the tool if you install it globally, if this happens you need to give the correct permissions or to avoid anything you can use `npx` which solves this problem.

```shell

npx clingon@latest gen

# or

npx clingon@latest init

# or

npx clingon@latest create ResourceName --preset preset-name

# or

npx clingon@latest scaffold ResourceName --template template-name

```

## Command modes

Read more on: [clingon.dev/docs/guide/commands](https://www.clingon.dev/docs/guide/commands)

- Commands shortcuts

  - `init`: [Init doc](https://www.clingon.dev/docs/guide/commands#init-command)

  - `gen`: [Gen doc](https://www.clingon.dev/docs/guide/commands#gen-command)

  - `create`: [Create doc](https://www.clingon.dev/docs/guide/commands#create-command)

  - `scaffold`: [Scaffold doc](https://www.clingon.dev/docs/guide/commands#scaffold-command)