├── .editorconfig ├── .gitignore ├── .npmignore ├── README.md ├── package.json ├── providers └── README.md └── src └── README.md /.editorconfig: -------------------------------------------------------------------------------- 1 | # editorconfig.org 2 | root = true 3 | 4 | [*] 5 | indent_size = 2 6 | indent_style = space 7 | end_of_line = lf 8 | charset = utf-8 9 | trim_trailing_whitespace = true 10 | insert_final_newline = true 11 | 12 | [*.md] 13 | trim_trailing_whitespace = false 14 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | coverage 2 | node_modules 3 | .DS_Store 4 | npm-debug.log 5 | .idea 6 | out 7 | .nyc_output 8 | package-lock.json 9 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | coverage 2 | node_modules 3 | .DS_Store 4 | npm-debug.log 5 | test 6 | .travis.yml 7 | .editorconfig 8 | benchmarks 9 | .idea 10 | bin 11 | out 12 | .nyc_output 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Adonis Addon 2 | 3 | This is a boilerplate for creating AdonisJs Addons. It is suggested to read [addons guide](http://adonisjs.com/recipes/making-adonis-addons) to learn more about the development process. 4 | 5 | ## Dependencies 6 | This project includes following dependencies, you are free to remove them. 7 | 8 | 1. [japa](https://github.com/thetutlage/japa) - Test runner to run tests 9 | 2. [standardjs](https://standardjs.com/) - Code linter 10 | 11 | ## Things to note 12 | 13 | 1. Always include `@adonisjs/fold` as a dev dependency to your addon. 14 | 2. Use `require.main.require('@adonisjs/fold')` vs `require('@adonisjs/fold')` when importing the IoC container dependency. 15 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "adonis-addon", 3 | "version": "1.0.0", 4 | "description": "A sample addon for AdonisJs", 5 | "main": "index.js", 6 | "scripts": { 7 | "lint": "standard", 8 | "pretest": "npm run lint", 9 | "test": "japa" 10 | }, 11 | "private": true, 12 | "keywords": [ 13 | "adonisjs", 14 | "adonis-framework" 15 | ], 16 | "author": "", 17 | "license": "", 18 | "devDependencies": { 19 | "@adonisjs/sink": "^1.0.13", 20 | "japa": "^1.0.5", 21 | "japa-cli": "^1.0.1", 22 | "standard": "^10.0.3" 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /providers/README.md: -------------------------------------------------------------------------------- 1 | # /providers 2 | 3 | Keep your providers inside this folder, ideally a single provider file is required, but feel free to create more. 4 | -------------------------------------------------------------------------------- /src/README.md: -------------------------------------------------------------------------------- 1 | # /src 2 | 3 | You keep all of your src code inside this folder. 4 | --------------------------------------------------------------------------------