# @adonisjs/ignitor

> Fire the adonis-app (in good sense)

Latest version **2.0.8** (published 2018-10-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @adonisjs/ignitor
pnpm add @adonisjs/ignitor
yarn add @adonisjs/ignitor
bun add @adonisjs/ignitor
```

Provides the command `ignitor`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.8 |
| Published | 2018-10-01 |
| First published | 2017-06-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 38.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18 |
| Author | adonisjs |
| Maintainers | romainlanz, virk |
| Keywords | adonisjs, adonis-bootstrapper, adonis-bootstraper |

## Links

- npm: https://www.npmjs.com/package/@adonisjs/ignitor
- Repository: https://github.com/adonisjs/adonis-ignitor
- Homepage: https://github.com/adonisjs/adonis-ignitor#readme
- Issues: https://github.com/adonisjs/adonis-ignitor/issues
- npm.io page: https://npm.io/package/@adonisjs/ignitor

## Dependencies (4)

- [pify](https://npm.io/package/pify.md) ^4.0.0
- [debug](https://npm.io/package/debug.md) ^4.0.1
- [youch](https://npm.io/package/youch.md) ^2.0.10
- [youch-terminal](https://npm.io/package/youch-terminal.md) ^1.0.0

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@atlaskit/theme](https://npm.io/package/@atlaskit/theme.md) — 402.0K weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads

## Recent versions

- 2.0.8 (latest) — 2018-10-01
- 2.0.7 — 2018-07-17
- 2.0.6 — 2018-03-18
- 2.0.5 — 2018-02-08
- 2.0.4 — 2018-02-08
- 2.0.3 — 2018-02-07
- 2.0.2 — 2018-02-07
- 2.0.1 — 2018-02-07
- 2.0.0 — 2018-01-31
- 1.0.14 — 2017-10-31
- 1.0.13 — 2017-10-29
- 1.0.12 — 2017-10-03
- 1.0.11 — 2017-09-14
- 1.0.10 — 2017-08-22
- 1.0.9 — 2017-08-22
- … 9 more at https://npm.io/package/@adonisjs/ignitor/versions

## README

# Adonis Ignitor 🔥

This repo contains all the code for bootstraping AdonisJs applications. It removes all the boilerplate code from your AdonisJs apps to keep them clean 🛁 

[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Appveyor][appveyor-image]][appveyor-url]
[![Coveralls][coveralls-image]][coveralls-url]

<img src="http://res.cloudinary.com/adonisjs/image/upload/q_100/v1497112678/adonis-purple_pzkmzt.svg" width="200px" align="right" hspace="30px" vspace="140px">

## What it does?

This repo performs following actions in order.

1. Load application `package.json` file.
2. Register the `Helpers` provider, since it needs to be ready before registering any other providers.
3. Load hooks file from `start/hooks.js` ( if exists ).
4. Register all the providers from `start/app.js` file.
5. Boot all registered providers.
6. Define aliases for providers.
7. Setup global exception handler by loading `app/Exceptions/Handler.js` file (if any).
8. Loads files to be preloaded.
9. Registers `ace` commands if process is started by the `ace` command line or someone manually instructs ignitor to load commands.

## Node/OS Target

This repo/branch is supposed to run fine on all major OS platforms and targets `Node.js >=7.0`

## Development

Great! If you are planning to contribute to this module, make sure to adhere to following conventions, since a consistent code-base is always joy to work with.

Run the following command to see list of available npm scripts.

```
npm run
```

### Tests & Linting

1. Lint your code using standardJs. Run `npm run lint` command to check if there are any linting errors.
2. Make sure you write tests for all the changes/bug fixes.
3. Also you can write **regression tests**, which shows that something is failing but doesn't breaks the build. Which is actually a nice way to show that something fails. Regression tests are written using `test.failing()` method.
4. Make sure all the tests are passing on `travis` and `appveyor`.

### General Practices

Since Es6 is in, you should strive to use latest features. For example:

1. Use `Spread` over `arguments` keyword.
2. Never use `bind` or `call`. After calling these methods, we cannot guarantee the scope of any methods and in AdonisJs codebase we do not override the methods scope.
3. Make sure to write proper docblock.

## Issues & PR

It is always helpful if we try to follow certain practices when creating issues or PR's, since it will save everyone's time.

1. Always try creating regression tests when you find a bug (if possible).
2. Share some context on what you are trying to do, with enough code to reproduce the issue.
3. For general questions, please create a forum thread.
4. When creating a PR for a feature, make sure to create a parallel PR for docs too.


## Regression Tests

Regression tests are tests, which shows how a piece of code fails under certain circumstance, but the beauty is even after the failure, the test suite will never fail. Actually is a nice way to notify about bugs, but making sure everything is green.

The regression tests are created using

```
test.failing('2 + 2 is always 4, but add method returns 6', (assert) => {
 assert.true(add(2, 2), 4)
})
```

Now since the `add` method has a bug, it will return `6` instead of `4`. But the build will pass.

[appveyor-image]: https://img.shields.io/appveyor/ci/thetutlage/adonis-ignitor/master.svg?style=flat-square

[appveyor-url]: https://ci.appveyor.com/project/thetutlage/adonis-ignitor

[npm-image]: https://img.shields.io/npm/v/@adonisjs/ignitor.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@adonisjs/ignitor

[travis-image]: https://img.shields.io/travis/adonisjs/adonis-ignitor/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/adonisjs/adonis-ignitor

[coveralls-image]: https://img.shields.io/coveralls/adonisjs/adonis-ignitor/develop.svg?style=flat-square

[coveralls-url]: https://coveralls.io/github/adonisjs/adonis-ignitor

---
_Source: https://npm.io/package/@adonisjs/ignitor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._