Giter Club home page Giter Club logo

clingon's Introduction

Clingon CLI logo

Build CI Release CI Coverage Status Website

GitHub Release Date GitHub Release version NPM Version

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 πŸ”—

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.

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

clingon's People

Contributors

ipetinate avatar dependabot[bot] avatar

Stargazers

blackbelt.py avatar Van Dinh Tam HUYNH avatar Daniel Nass avatar Sergey Klochko avatar  Vivek Rp avatar Lucas Oliveira avatar Jefferson Daniel avatar Luiz Felicio avatar Gabriel Galdino avatar Luís Lança avatar

Watchers

Pedro Silva avatar  avatar

clingon's Issues

Create a VS Code extension

Description

A VS Code extension to help create components based on saved presets and type preset json for manual creation

Generation with advanced mode

One of the main features of the CLI is the advanced mode, which uses local resources to generate content.

This function has not yet been implemented, as it is more complex, I am defining a mental model that would be ideal for use, I will still do some local PoCs before defining what it will be like.

But conceptually, I expect the CLI to read some template (.vue file, .jsx, etc) or use some JSON, Yaml, Toml (to be defined), or both, and build the components from that. What should be something very trivial, should not be complex to do, and should deliver a good user experience, which is why it has not yet been developed.

I accept suggestions!

Error: Should pass a string with slash separator, like a folder tree path

Input values

β”‚ Framework/Lib β”‚ 'react' β”‚
β”‚ Resource Type β”‚ 'component' β”‚
β”‚ Resource Name β”‚ 'Felicio' β”‚
β”‚ With TypeScript β”‚ 'Yes' β”‚
β”‚ CSS approach β”‚ 'Tailwind Inline (inside component)' β”‚
β”‚ With Story β”‚ 'No' β”‚
β”‚ With Unit Test β”‚ 'Yes' β”‚
β”‚ With Testing Library β”‚ 'Yes' β”‚
β”‚ My Test Postfix β”‚ 'spec' β”‚
β”‚ My Test Framework β”‚ 'vitest' β”‚
β”‚ Resource Path β”‚ 'src/components' β”‚
β”‚ Test Path β”‚ 'src/tests' β”‚

It throws an error Error: Should pass a string with slash separator, like a folder tree path, and just creates the component file

Node.js v20.11.0

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.