Skip to content

Commit

Permalink
chore: update build commands documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
robhrt7 committed Sep 20, 2015
1 parent 823f377 commit ad17ec3
Show file tree
Hide file tree
Showing 9 changed files with 36 additions and 33 deletions.
2 changes: 1 addition & 1 deletion docs/api/plugins/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ define([

As we mentioned above, when SourceJS plugin is installed through NPM, main client-side module of your plugin (`index.js`) is connected by default.

To achieve this, we generate custom RequireJS configuration through default Grunt task and dynamically extend `options.js`, filling installed modules to `assets.npmPluginsEnabled` with `true`.
To achieve this, we generate custom RequireJS configuration through default build task and dynamically extend `options.js`, filling installed modules to `assets.npmPluginsEnabled` with `true`.

To disable client-side module of any installed npm Plugins, you can edit the module definition in `user/options.js`:

Expand Down
2 changes: 1 addition & 1 deletion docs/base/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ During the initial set-up, generator will build everything for you. To re-build
npm run build
```

It will trigger `npm i` and `grunt default` commands for updating dependencies and building SourceJS assets. See the full list of [all Grunt tasks available](/docs/grunt).
It will trigger `npm i` and default build task for updating dependencies and building SourceJS assets. See the full list of [all build tasks available](/docs/build-tasks).

### Update

Expand Down
4 changes: 4 additions & 0 deletions docs/build-tasks/info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Build Tasks",
"template": "doc"
}
27 changes: 27 additions & 0 deletions docs/build-tasks/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Note that these commands are related only to SourceJS engine build and development cycle.

For building specs and other project related content use own build tasks from `sourcejs/user` folder.

## Scripts

All automation tasks are triggered through NPM scripts listed in `package.json`.

Here's a list of most common commands:

```js
$ npm run build
$ npm start

$ npm run watch
$ npm run watch:css

$ npm run lint

$ npm test
$ npm run test:unit
$ npm run test:func
```

* `npm run build` - default build command for preparing SourceJS assets, used as a post-install hook and after plugin installation
* `npm start` - runs the engine
* `npm run watch` - runs engine sources watcher, used in core client-side modules development
4 changes: 0 additions & 4 deletions docs/grunt/info.json

This file was deleted.

26 changes: 0 additions & 26 deletions docs/grunt/readme.md

This file was deleted.

Binary file removed docs/grunt/thumbnail.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/migration/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ Here you will find migration instructions from different Source versions

## From 0.4.0-beta to 0.4.0-rc

* Update engine files, run `npm i` and `grunt` at root of engine
* Update engine files, run `npm run build` in the root of engine
* If you have custom `user/core/views`, then add `info.*` namespace to all data in template that is taken from `info.json` (`info.author`, `info.title`, `info.keywords`)
* Set at your views and `*.html` spec files new path to main client-side file: `/source/assets/js/enter-the-source.js`
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@
"build": "npm i",
"lint": "grunt jshint",
"start": "node app",
"watch": "grunt watch-all",
"watch:css": "grunt watch-css",
"test": "grunt ci-pre-run && node app.js --test",
"test:unit": "grunt test",
"test:func": "grunt test-func",
Expand Down

0 comments on commit ad17ec3

Please sign in to comment.