Skip to content

Commit

Permalink
Merge pull request #25 from cl4pper/develop
Browse files Browse the repository at this point in the history
Develop
  • Loading branch information
cl4pper committed Nov 21, 2023
2 parents 0c0e01d + 0faf1db commit 136cfff
Show file tree
Hide file tree
Showing 10 changed files with 21 additions and 21 deletions.
8 changes: 4 additions & 4 deletions README.md
@@ -1,11 +1,11 @@
# nucleus-cli
# nuke-cli

A CLI focused in powering your React based project. By Typescript, or just clean Javascript.
A CLI focused in powering the star of your React based project.

## INSTRCTIONS:

To install: `yarn global add nucleus-cli` or `npm i -g nucleus-cli`.
To install: `yarn global add nuke-cli` or `npm i -g nuke-cli`.

To start a project: `ncl start:ts <INSERT_PROJECT_NAME>`
To start a project: `nuke start:ts <INSERT_PROJECT_NAME>`

Engineered by [Gluegun](https://github.com/infinitered/gluegun).
2 changes: 1 addition & 1 deletion __tests__/start:ts.test.ts
Expand Up @@ -5,7 +5,7 @@ const name = 'project'
let output: string // used into the artifact

const terminal = async (cmd) =>
system.run('node ' + filesystem.path(src, 'bin', 'nucleus-cli') + ` ${cmd}`)
system.run('node ' + filesystem.path(src, 'bin', 'nuke-cli') + ` ${cmd}`)

describe('start:ts', () => {
beforeAll(async () => {
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/commands.md
@@ -1,3 +1,3 @@
# Command Reference for nucleus-cli
# Command Reference for nuke-cli

TODO: Add your command reference here
14 changes: 7 additions & 7 deletions docs/plugins.md
@@ -1,10 +1,10 @@
# Plugin guide for nucleus-cli
# Plugin guide for nuke-cli

Plugins allow you to add features to nucleus-cli, such as commands and
Plugins allow you to add features to nuke-cli, such as commands and
extensions to the `toolbox` object that provides the majority of the functionality
used by nucleus-cli.
used by nuke-cli.

Creating a nucleus-cli plugin is easy. Just create a repo with two folders:
Creating a nuke-cli plugin is easy. Just create a repo with two folders:

```
commands/
Expand Down Expand Up @@ -44,6 +44,6 @@ This is then accessible in your plugin's commands as `toolbox.bar`.

# Loading a plugin

To load a particular plugin (which has to start with `nucleus-cli-*`),
install it to your project using `npm install --save-dev nucleus-cli-PLUGINNAME`,
and nucleus-cli will pick it up automatically.
To load a particular plugin (which has to start with `nuke-cli-*`),
install it to your project using `npm install --save-dev nuke-cli-PLUGINNAME`,
and nuke-cli will pick it up automatically.
4 changes: 2 additions & 2 deletions package.json
@@ -1,5 +1,5 @@
{
"name": "nucleus-cli",
"name": "nuke-cli",
"version": "1.0.0",
"description": "A CLI focused in powering your web based project.",
"author": {
Expand All @@ -8,7 +8,7 @@
},
"types": "build/types/types.d.ts",
"bin": {
"ncl": "bin/nucleus-cli"
"nuke": "bin/nuke-cli"
},
"scripts": {
"clean-build": "rimraf -rf ./build",
Expand Down
4 changes: 2 additions & 2 deletions src/cli.ts
Expand Up @@ -6,9 +6,9 @@ import { build } from 'gluegun'
async function run(argv) {
// create a CLI runtime
const cli = build()
.brand('nucleus-cli')
.brand('nuke-cli')
.src(__dirname)
.plugins('./node_modules', { matching: 'nucleus-cli-*', hidden: true })
.plugins('./node_modules', { matching: 'nuke-cli-*', hidden: true })
.help() // provides default for help, h, --help, -h
.version() // provides default for version, v, --version, -v
.create()
Expand Down
4 changes: 2 additions & 2 deletions src/commands/nucleus-cli.ts → src/commands/nuke-cli.ts
@@ -1,11 +1,11 @@
import { GluegunCommand } from 'gluegun'

const command: GluegunCommand = {
name: 'nucleus-cli',
name: 'nuke-cli',
run: async (toolbox) => {
const { print } = toolbox

print.info('Welcome to nucleus-cli.')
print.info('Welcome to nuke CLI.')
},
}

Expand Down
2 changes: 1 addition & 1 deletion src/templates/app.tsx.ejs
Expand Up @@ -5,7 +5,7 @@ import './App.sass';

const App = () => {
return (
<div>App by <b>nucleus-cli</b></div>
<div>App by <b>nuke CLI</b></div>
);
};

Expand Down
2 changes: 1 addition & 1 deletion src/templates/readme.ejs
@@ -1,6 +1,6 @@
# <%= props.name %>

This project has beeen generated by [Nucleus CLI](https://github.com/cl4pper/nucleus-cli) :smiley:
This project has beeen generated by [nuke-cli](https://github.com/cl4pper/nuke-cli) :smiley:

You can find the original boilerplate on [react-setup](https://github.com/cl4pper/react-setup).

Expand Down

0 comments on commit 136cfff

Please sign in to comment.