Skip to content

Commit 00484ba

Browse files
committed
templates optimized, test added
1 parent e056e40 commit 00484ba

File tree

9 files changed

+1868
-17
lines changed

9 files changed

+1868
-17
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ node_modules
66
# builds
77
build
88
dist
9+
jq-test
910

1011
# misc
1112
.DS_Store

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# create-jquery-plugin
22
#### CLI for creating ready-to-start modern jQuery Plugins
3-
###### Inspired from [create-react-library](https://www.npmjs.com/package/create-react-library) and [create-react-app](https://github.com/facebook/create-react-app)
3+
##### Inspired from [create-react-library](https://www.npmjs.com/package/create-react-library) and [create-react-app](https://github.com/facebook/create-react-app)
44

55

66
[![Build Status](https://travis-ci.org/techlab/create-jquery-plugin.svg?branch=master)](https://travis-ci.org/techlab/create-jquery-plugin)
@@ -12,7 +12,7 @@
1212

1313

1414
**create-jquery-plugin** is a CLI tool for creating a ready-to-start jQuery plugin development environment with modern configurations.
15-
It will create a development environment with a pre-configured build system. So you can get started immediately with your plugin development.
15+
It will create a development environment with a pre-configured build system and you can get started immediately with your plugin development.
1616
Also, it is easily customizable that allows you to add or remove any tools or setup.
1717
The development setup will include the boilerplate project for the jQuery plugin development, pre-configured gulp tasks for JavaScript transpile,
1818
CSS/SCSS building, test/lint scripts, hot loading, example page, readme, etc.
@@ -24,7 +24,7 @@ CSS/SCSS building, test/lint scripts, hot loading, example page, readme, etc.
2424
Usage
2525
-----
2626

27-
The command will walk you through a few simple prompts and creates a ready to start local development setup for your new jQuery plugin.
27+
The command will walk you through a few simple prompts and creates a ready-to-start local development setup for your new jQuery plugin.
2828

2929
```bash
3030
npx create-jquery-plugin
@@ -35,7 +35,7 @@ Or, fast track with default settings, just pass your plugin name.
3535
npx create-jquery-plugin jquery-my-plugin
3636
```
3737

38-
It will create a directory with the name of your package with all the tools installed.
38+
This will create a directory with the your plugin name and with all the tools installed.
3939

4040

4141
How to start the development

lib/cli.js

+1-3
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ ${chalk.italic(description)}`)
1313

1414
// Get the package settings
1515
const params = await getParams()
16-
// console.log(params); process.exit(1);
17-
1816

1917
await createPlugin(params)
2018

@@ -23,7 +21,7 @@ ${chalk.italic(description)}`)
2321
${chalk.green.bold(`Your jQuery plugin has been created at`)} ${chalk.dim.bold(params.dest)}.
2422
To get started, run: ${chalk.cyan(`cd ${params.shortName} && ${params.manager} start`)}
2523
26-
Happy Coding
24+
Happy Coding!
2725
`)
2826

2927
return params

lib/create-plugin.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ ${chalk.dim.bold(`Creating jQuery plugin`)} ${chalk.green.bold(params.name)}`)
6060
ora(`Install dependencies error => ${chalk.cyan(`${params.manager}`)} not installed. Please install ${chalk.cyan(`${params.manager}`)} and then run ${chalk.cyan(`${params.manager} install`)} on your project directory`).fail();
6161
}
6262

63-
return dest
63+
return true
6464
}

0 commit comments

Comments
 (0)