Skip to content

Commit

Permalink
[patch] [chore] rename clap.js to xclap.js
Browse files Browse the repository at this point in the history
  • Loading branch information
jchip committed Jun 22, 2017
1 parent daeffd8 commit d905bfa
Show file tree
Hide file tree
Showing 24 changed files with 28 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Below is the new structure of the Electrode React Component Archetype:
| |- archetype.js
|- scripts/
|- archetype-clap.js
|- clap.js
|- xclap.js
|- package.json
...
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Here is the layout of packages/<componentName>:
└── packages
└── <componentName>
├── README.md
├── clap.js
├── xclap.js
├── package.json
├── src
│ ├── components
Expand Down Expand Up @@ -49,7 +49,7 @@ Here is the layout of demo-app:
│ │ ├── development.json
│ │ ├── production.js
│ │ └── production.json
│ ├── clap.js
│ ├── xclap.js
│ ├── package.json
│ ├── src
│ │ ├── client
Expand Down
2 changes: 1 addition & 1 deletion docs/chapter1/quick-start/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Let's take a quick high level overview of our file structure and what `generator

A file where you can customize any process in the Travis default build environment.

- `clap.js`
- `xclap.js`

A file that stores all your development tasks. We will explore this more in [Getting Started: Intermediate](/chapter1/Intermediate.md).

Expand Down
2 changes: 1 addition & 1 deletion packages/electrode-archetype-react-app/.npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -514,5 +514,5 @@ tmp
/.npmignore
/.eslintrc
/test
/clap.js
/xclap.js
/.nyc_output
4 changes: 2 additions & 2 deletions packages/electrode-archetype-react-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ $ npm install --save electrode-archetype-react-app
$ npm install --save-dev electrode-archetype-react-app-dev
```

###### Add a `clap.js`
###### Add a `xclap.js`

The `clap.js` should contain the following and be located in the root of your project
The `xclap.js` should contain the following and be located in the root of your project

```js
require("electrode-archetype-react-app")();
Expand Down
2 changes: 1 addition & 1 deletion packages/electrode-archetype-react-component/.npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -514,4 +514,4 @@ tmp
###############################################################################

/.npmignore
/clap.js
/xclap.js
26 changes: 15 additions & 11 deletions packages/electrode-archetype-react-component/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ react, webpack, demo, electrode component archetype, live-reload
create .gitignore
create .npmignore
create .editorconfig
create clap.js
create xclap.js
create package.json
create README.md
create src/components/product-card.jsx
Expand All @@ -52,7 +52,6 @@ react, webpack, demo, electrode component archetype, live-reload
create test/client/components/product-card.spec.jsx

Your new Electrode Component is ready and your component is in '/src'.

```

## Configuring an existing project / manual setup
Expand All @@ -65,7 +64,6 @@ If you prefer to create your component manually or if you have an existing compo
$ npm install --save-dev electrode-archetype-react-component electrode-archetype-react-component-dev
```


###### Add a `.babelrc` to your project

The `.babelrc` needs to extend
Expand All @@ -77,10 +75,10 @@ The `.babelrc` needs to extend
}
```

###### Add a `clap.js` to your project
###### Add a `xclap.js` to your project

The `clap.js` needs to extend
[the archetype's clap tasks](/arhcetype-clap.js) in order to apply the shared tasks on your new/existing electrode component. Add this following lines of code to the newly created `clap.js`
The `xclap.js` needs to extend
[the archetype's clap tasks](/arhcetype-clap.js) in order to apply the shared tasks on your new/existing electrode component. Add this following lines of code to the newly created `xclap.js`

```js
"use strict";
Expand All @@ -96,12 +94,11 @@ xclap.load("myprj", tasks);
require("electrode-archetype-react-component")(xclap);
```


## Managing Dependencies

The archetypes are split into two parts: `<archetype>` and `<archetype>-dev`. Both archetypes need to be in each component and should be included in the `package.json`'s `devDependencies`.

---
* * *

## Project Structure

Expand Down Expand Up @@ -131,7 +128,7 @@ package.json
## CSS Modules + CSS next

By default, this archetype assumes you are using CSS-Modules + CSS-Next, you need
to opt-in to stylus support by adding a `*.styl` to your *project's* `demo/demo.styl` & `src/styles/*.styl`.
to opt-in to stylus support by adding a `*.styl` to your _project's_ `demo/demo.styl` & `src/styles/*.styl`.
You can use stylus and CSS-Modules together by enabling setting the 'cssModuleStylusSupport' option in
`archetype/config.js` to `true`.

Expand Down Expand Up @@ -184,10 +181,17 @@ $ clap archetype:check
Built with :heart: by [Team Electrode](https://github.com/orgs/electrode-io/people) @WalmartLabs.

[npm-image]: https://badge.fury.io/js/electrode-archetype-react-component.svg

[npm-url]: https://npmjs.org/package/electrode-archetype-react-component

[daviddm-image]: https://david-dm.org/electrode-io/electrode/status.svg?path=packages/electrode-archetype-react-component

[daviddm-url]: https://david-dm.org/electrode-io/electrode?path=packages/electrode-archetype-react-component

[daviddm-dev-image]: https://david-dm.org/electrode-io/electrode/dev-status.svg?path=packages/electrode-archetype-react-component

[daviddm-dev-url]: https://david-dm.org/electrode-io/electrode?path=packages/electrode-archetype-react-component?type=dev
[npm-downloads-image]:https://img.shields.io/npm/dm/electrode-archetype-react-component.svg
[npm-downloads-url]:https://www.npmjs.com/package/electrode-archetype-react-component

[npm-downloads-image]: https://img.shields.io/npm/dm/electrode-archetype-react-component.svg

[npm-downloads-url]: https://www.npmjs.com/package/electrode-archetype-react-component
3 changes: 1 addition & 2 deletions packages/electrode-auto-ssr/.npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,5 @@ tmp
###############################################################################

/.npmignore
/clap.js
/xclap.js
/test

File renamed without changes.
2 changes: 1 addition & 1 deletion packages/electrode-react-webapp/.npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ lib/templates
minified/

/.npmignore
/clap.js
/xclap.js
/.eslintrc
/.eslintignore
/.babelrc
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion packages/electrode-redux-router-engine/.npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,6 @@ node_modules
dist

/.npmignore
/clap.js
/xclap.js
/.babelrc
/test
2 changes: 1 addition & 1 deletion packages/electrode-webpack-reporter/.npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ node_modules
.isomorphic-loader-config.json

/.npmignore
/clap.js
/xclap.js
/.babelrc
/test
/.eslintrc
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion samples/electrode-demo-index/.npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ cache

bower_components

clap.js
xclap.js
Procfile
.git
.hg
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit d905bfa

Please sign in to comment.