Skip to content

Commit

Permalink
Dig >> aegir
Browse files Browse the repository at this point in the history
  • Loading branch information
RichardLitt committed Apr 13, 2016
1 parent 20cab3d commit e075595
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions js-project-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Remember:
- [Test](#test)
- [Build](#build)
- [Release](#release)
- [Dignified.js](#dignifiedjs)
- [AEgir.js](#aegirjs)

This comment has been minimized.

Copy link
@dignifiedquire

dignifiedquire Apr 13, 2016

Member

It's called just Aegir without the .js

- [...for maintainers](#for-maintainers)
- [Setting up `dignified.js`](#setting-up-dignifiedjs)
- [Setting up `aegir.js`](#setting-up-aegirjs)
- [Directory Structure](#directory-structure)
- [Default `require`](#default-require)
- [Continuous integration](#continuous-integration)
Expand Down Expand Up @@ -97,51 +97,51 @@ Each time a new release happens, these are the steps we follow to make sure noth
7. Push to GitHub
8. Publish to npm

## Dignified.js
## aegir.js

We've created a module to help us achieve all of the above with minimal effort. Feel free to also use it for your projects. Feedback is appreciated!

#### ...for maintainers

##### Setting up `dignified.js`
##### Setting up `aegir.js`

There are a couple of binaries that `dignified.js` provides for you to use
There are a couple of binaries that `aegir.js` provides for you to use

```sh
$ dignified-lint
$ dignified-test
$ dignified-test browser
$ dignified-test node
$ dignified-build
$ dignified-release major
$ dignified-release minor
$ dignified-release
$ aegir-lint
$ aegir-test
$ aegir-test browser
$ aegir-test node
$ aegir-build
$ aegir-release major
$ aegir-release minor
$ aegir-release
```

If you prefer using npm scripts, you can set them up in your package.json:

```json
{
"scripts": {
"lint": "dignified-lint",
"build": "dignified-build",
"test": "dignified-test",
"test:node": "dignified-test node",
"test:browser": "dignified-test browser",
"release": "dignified-release"
"lint": "aegir-lint",
"build": "aegir-build",
"test": "aegir-test",
"test:node": "aegir-test node",
"test:browser": "aegir-test browser",
"release": "aegir-release"
}
}
```

You also need to add it your `devDependencies` by running:

```sh
$ npm install --save-dev dignified.js
$ npm install --save-dev aegir.js
```

##### Directory Structure

To reduce the amount of configuration dignified.js expects your source code to be in the src and your test files in the test directory.
To reduce the amount of configuration aegir.js expects your source code to be in the src and your test files in the test directory.

```sh
├── dist # auto-generated by the transpile and minification task.
Expand Down Expand Up @@ -241,7 +241,7 @@ There are two possibilities: either it didn’t work out for us, or we don’t k

#### Why not use simple npm scripts instead of gulp?

Gulp is not a hard dependency. It’s just a simple way to structure our tasks at the moment. Usually projects only depend on the dignified binaries completely hiding the fact that we are using gulp under the hood. So we are free if we want to switch it out without any issues. We all enjoy npm scripts, and are using them to call the dignified binaries, but there is no nice way of sharing them yet.
Gulp is not a hard dependency. It’s just a simple way to structure our tasks at the moment. Usually projects only depend on the aegir binaries completely hiding the fact that we are using gulp under the hood. So we are free if we want to switch it out without any issues. We all enjoy npm scripts, and are using them to call the aegir binaries, but there is no nice way of sharing them yet.

#### Where are all the semicolons?

Expand All @@ -251,7 +251,7 @@ Our linting rules are compatible with [standard](https://github.com/feross/stand

We want to see the web move forward, and some of us enjoy writing their JavaScript with things like `const` and arrow functions.

#### Do I have to use ES2015 and Babel and Dignified.js in my project?
#### Do I have to use ES2015 and Babel and aegir.js in my project?

No.

Expand Down

0 comments on commit e075595

Please sign in to comment.