diff --git a/Readme.md b/Readme.md
index d16d91ff..b6ac5d06 100644
--- a/Readme.md
+++ b/Readme.md
@@ -21,7 +21,7 @@ $ npm install -g dev-toolkit
```
```bash
-# Initialize a project with optional name, template, comments
+# Initialise a project with optional name, template, comments
# The comments explain how the `dev-toolkit` works with the template
$ dev-toolkit init [project_name] [--template template_name] [--skip-comments]
```
diff --git a/src/feature-tests/src/templates/all/index.js b/src/feature-tests/src/templates/all/index.js
index 38568523..7446d7f3 100644
--- a/src/feature-tests/src/templates/all/index.js
+++ b/src/feature-tests/src/templates/all/index.js
@@ -12,7 +12,7 @@ const logOutput = output => {
};
export default ({ name, isDefault } = { isDefault: false }) => {
- describe('can be used to initialize a new app', () => {
+ describe('can be used to Initialise a new app', () => {
// Optional templates can take up to 2 minutes to install
it(`including comments, with specified template '${name}'`, done => {
runDevToolkitCli({
diff --git a/src/packages/dev-toolkit/Readme.md b/src/packages/dev-toolkit/Readme.md
index bfcfb6dc..b6ac5d06 100644
--- a/src/packages/dev-toolkit/Readme.md
+++ b/src/packages/dev-toolkit/Readme.md
@@ -5,12 +5,10 @@ Jump-start your react-powered Universal App
-`dev-toolkit` provides you with an easy and quick way to get started with a pre-rendered &
-server-rendered app. After creating your starting point with the `init` command, you get full
-customizeability out of the box.
+`dev-toolkit` provides you with an easy and quick way to get started with a pre-rendered & server-rendered app. After creating your starting point with the `init` command, you get full customisability out of the box.
[](https://github.com/stoikerty/dev-toolkit)
-[](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=packages%2Fdev-toolkit%2Fpackage.json)
+[](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Fpackages%2Fdev-toolkit%2Fpackage.json)
[](https://www.npmjs.com/package/dev-toolkit)
[](https://www.npmjs.com/package/dev-toolkit)
[](https://github.com/prettier/prettier)
@@ -23,64 +21,59 @@ $ npm install -g dev-toolkit
```
```bash
-# Initialize a project with optional name, template, comments
+# Initialise a project with optional name, template, comments
# The comments explain how the `dev-toolkit` works with the template
$ dev-toolkit init [project_name] [--template template_name] [--skip-comments]
```
#### List of available templates
-- `standard` [](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=templates%2Fstandard%2Fpackage.json)
-- `with-eslint` [](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=templates%2Fwith-eslint%2Fpackage.json)
-- `with-sass` [](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=templates%2Fwith-sass%2Fpackage.json)
+- [`minimal`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#minimal) [](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fminimal%2Fpackage.json)
+- [`standard`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#standard)* [](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fstandard%2Fpackage.json)
+- [`with-eslint`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#with-eslint) [](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fwith-eslint%2Fpackage.json)
+- [`with-sass`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#with-sass) [](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fwith-sass%2Fpackage.json)
-## Features
+* used by default when initialising a new project
-* hot-reload on client by default
-* server-rendering
-* pre-rendering
-* creating a build
-* custom webpack config
-* use environment variables on client
+## 📖 Docs
-### No CSS by default
+- [Templates](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md)
-With CSS-in-JS solutions on the rise, it would be unwise to include dependencies for css-modules,
-sass or less in every project that has `dev-toolkit` as a dependency which would introduce
-additional installation time and bloat. The aim of dev-toolkit is to be unopinionated so that it can
-be useful in many scenarios.
+## 🌟 Features
-## Contributing
+`dev-toolkit` is intentionally minimalist on features. It's meant to get you started quickly with a project where you _will_ need customisability instead of mandating which technologies that you must use (such as Jest).
-Check out the project locally & create a PR.
+* **SSR by default**
+* **Ability to pre-render** _after_ webpack creates a build
+* **Complete control over client & server**
+ _see [template docs](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md)_
+* **Start your project without bloat** _or guidance_ if you like it rough
+ _`dev-toolkit init --template minimal --skip-comments`_
+* **Full control over your server-rendered template**
+ _no webpack lock-in such as with [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin) unless you choose to_
+* **hot-reload on client & server**, opt-in for both
+* **Easy way to integrate any nodeHooks for SSR usage**
+ _using `/nodeHooks.js`_
+* **Easy way to add webpack plugins and presets**
+ _using `/dev-toolkit.config.js`_
+* **use select environment variables on client**
+ _using `import { sharedEnvs } from 'dev-toolkit/settings'`_
+* **you can use sane if-statements, [jsx-control-statements](https://github.com/AlexGilleran/jsx-control-statements)**
+ _` ... ` will compile down to `&&`-syntax_
-```bash
-# Clone down the repo locally
-$ git clone git@github.com:stoikerty/dev-toolkit.git
-
-# Install root lerna dependencies
-$ cd dev-toolkit
-$ npm install
-
-# Bootstrap all packages
-$ npm run bootstrap
-# If you encounter linux/osx permission issues, try this
-$ npm run bootstrap-fix
-
-# Run feature tests
-$ cd feature-tests
-$ npm install
-$ npm run test
-```
+### Why No CSS by default?
-Your workflow will likely be to `cd` into a template of your choice in the `templates` directory
-where you can test `dev-toolkit` and in parallel (in a separate terminal) re-run the
-`bootstrap`-command in the root of the project after making changes in one of the `packages`.
+The aim of dev-toolkit is to be unopinionated so that it can be useful in many different scenarios. Therefore only the most necessary dependencies are included and other additions may be provided by yourself (see the other template examples for guidance).
+
+With CSS-in-JS solutions on the rise, it would be unwise to include dependencies for `css-modules`, `sass` or `less` in every project that has `dev-toolkit` as a dependency, it would introduce additional installation time and bloat.
### Roadmap
-* Improved docs
+* More docs on extending with config, how dev-toolkit works, choices
+* serverless template
* Using your own (external) template - under consideration
* Eject feature - under consideration
-* serverless template - in development
* list differences between dev-toolkit, next.js & create-react-app
+
+## Contributing
+See [`Contributing.md`](https://github.com/stoikerty/dev-toolkit/blob/master/Contributing.md)
diff --git a/src/packages/dev-toolkit/package-lock.json b/src/packages/dev-toolkit/package-lock.json
index 3cf705ee..e2ee8220 100644
--- a/src/packages/dev-toolkit/package-lock.json
+++ b/src/packages/dev-toolkit/package-lock.json
@@ -1,6 +1,6 @@
{
"name": "dev-toolkit",
- "version": "6.0.2",
+ "version": "6.0.5",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
diff --git a/src/packages/dev-toolkit/package.json b/src/packages/dev-toolkit/package.json
index 9073ba20..2a3c7a41 100644
--- a/src/packages/dev-toolkit/package.json
+++ b/src/packages/dev-toolkit/package.json
@@ -1,6 +1,6 @@
{
"name": "dev-toolkit",
- "version": "6.0.4",
+ "version": "6.0.5",
"description": "Universal Development Toolkit for React Veterans",
"main": "dev-toolkit.js",
"files": [
diff --git a/src/packages/dev-toolkit/src/bin/index.js b/src/packages/dev-toolkit/src/bin/index.js
index 28fd8d94..e7ec718f 100644
--- a/src/packages/dev-toolkit/src/bin/index.js
+++ b/src/packages/dev-toolkit/src/bin/index.js
@@ -10,7 +10,7 @@ const devToolkit = ({ cmdArgs }) => {
.command({
command: 'init',
aliases: ['init', 'i'],
- desc: 'Initializes a new project',
+ desc: 'Initialises a new project',
handler: argv =>
runCommand({
options: {
@@ -21,7 +21,7 @@ const devToolkit = ({ cmdArgs }) => {
skipComments: argv.skipComments || argv['skip-comments'] || false,
},
command: 'init',
- message: 'Initializing a new project',
+ message: 'Initialising a new project',
}),
})
.command({
@@ -42,7 +42,7 @@ const devToolkit = ({ cmdArgs }) => {
})
.command({
command: 'version',
- aliases: ['version', 'v', '-v'],
+ aliases: ['version', 'v'],
desc: 'Outputs current version number',
handler: () =>
runCommand({
diff --git a/src/packages/dev-toolkit/src/bin/index.spec.js b/src/packages/dev-toolkit/src/bin/index.spec.js
index 0b64f4c2..e65e852a 100644
--- a/src/packages/dev-toolkit/src/bin/index.spec.js
+++ b/src/packages/dev-toolkit/src/bin/index.spec.js
@@ -89,7 +89,7 @@ describe('dev-toolkit', () => {
const processedArgs = yargs.alias('i', 'init').parse(['dev-toolkit', '-i']);
const expectedOutput = {
script: 'init',
- message: 'Initializing new project',
+ message: 'Initialising new project',
args: [processedArgs.init],
};
diff --git a/src/packages/dev-toolkit/src/commands/init.js b/src/packages/dev-toolkit/src/commands/init.js
index bd6e43e0..98a29ef8 100644
--- a/src/packages/dev-toolkit/src/commands/init.js
+++ b/src/packages/dev-toolkit/src/commands/init.js
@@ -30,7 +30,7 @@ if (template && !templateExists) {
log({ message: 'You can use one of the following templates:' });
templatesList.forEach(name => log({ message: `• ${name}` }));
log({
- message: `\nProject will be initialized using default template files (${defaultTemplate}).`,
+ message: `\nProject will be Initialised using default template files (${defaultTemplate}).`,
useSeparator: true,
});
}
diff --git a/src/templates/minimal/package.json b/src/templates/minimal/package.json
index 10a586eb..c5c8a724 100644
--- a/src/templates/minimal/package.json
+++ b/src/templates/minimal/package.json
@@ -12,7 +12,7 @@
"dependencies": {
"babel-preset-dev-toolkit": "1.0.0",
"cross-env": "^5.0.5",
- "dev-toolkit": "6.0.4",
+ "dev-toolkit": "6.0.5",
"express": "^4.15.5",
"react": "^16.0.0",
"react-dom": "^16.0.0"
diff --git a/src/templates/serverless/package.json b/src/templates/serverless/package.json
index cd846084..9375837b 100644
--- a/src/templates/serverless/package.json
+++ b/src/templates/serverless/package.json
@@ -14,7 +14,7 @@
"babel-preset-dev-toolkit": "1.0.0",
"clear-module": "^2.1.0",
"cross-env": "^5.0.5",
- "dev-toolkit": "6.0.4",
+ "dev-toolkit": "6.0.5",
"express": "^4.15.5",
"express-handlebars": "^3.0.0",
"react": "^16.0.0",
diff --git a/src/templates/standard/package.json b/src/templates/standard/package.json
index 833a88ff..3f8f4ed1 100644
--- a/src/templates/standard/package.json
+++ b/src/templates/standard/package.json
@@ -36,7 +36,7 @@
"babel-preset-dev-toolkit": "1.0.0",
"better-npm-run": "^0.1.0",
"clear-module": "^2.1.0",
- "dev-toolkit": "6.0.4",
+ "dev-toolkit": "6.0.5",
"express": "^4.15.5",
"express-handlebars": "^3.0.0",
"react": "^16.0.0",
diff --git a/src/templates/with-eslint/package.json b/src/templates/with-eslint/package.json
index 2b00748c..a25fdfe5 100644
--- a/src/templates/with-eslint/package.json
+++ b/src/templates/with-eslint/package.json
@@ -36,7 +36,7 @@
"babel-preset-dev-toolkit": "1.0.0",
"better-npm-run": "^0.1.0",
"clear-module": "^2.1.0",
- "dev-toolkit": "6.0.4",
+ "dev-toolkit": "6.0.5",
"express": "^4.15.5",
"express-handlebars": "^3.0.0",
"react": "^16.0.0",
diff --git a/src/templates/with-sass/package.json b/src/templates/with-sass/package.json
index f9357986..e02f0244 100644
--- a/src/templates/with-sass/package.json
+++ b/src/templates/with-sass/package.json
@@ -17,7 +17,7 @@
"cross-env": "^5.0.5",
"css-loader": "^0.28.7",
"css-modules-require-hook": "^4.2.2",
- "dev-toolkit": "6.0.4",
+ "dev-toolkit": "6.0.5",
"express": "^4.15.5",
"express-handlebars": "^3.0.0",
"extract-text-webpack-plugin": "^3.0.1",