|
1 |
| -# AEgir |
2 |
| -[](https://protocol.ai) |
3 |
| -[](https://ipfs.io/) |
| 1 | +# AEgir |
| 2 | +[](https://protocol.ai) |
| 3 | +[](https://ipfs.io/) |
4 | 4 | [](http://webchat.freenode.net/?channels=%23ipfs)
|
5 | 5 | 
|
6 | 6 |
|
7 | 7 | > Automated JavaScript project management.
|
8 | 8 |
|
9 |
| -## Lead Maintainer |
| 9 | +## Lead Maintainer |
10 | 10 |
|
11 | 11 | [Hugo Dias](https://github.com/hugomrdias)
|
12 | 12 |
|
13 | 13 | ## Project Structure
|
14 | 14 |
|
15 |
| -The project structure when using this is quite strict, to ease |
16 |
| -replication and configuration overhead. |
| 15 | +The project structure when using this is quite strict, to ease replication and configuration overhead. |
17 | 16 |
|
18 |
| -All source code should be placed under `src`, with the main entry |
19 |
| -point being `src/index.js`. |
| 17 | +All source code should be placed under `src`, with the main entry point being `src/index.js` or `src/index.ts`. |
20 | 18 |
|
21 |
| -All test files should be placed under `test`. Individual test files should end in `.spec.js` and will be ran in all environments (node, browser, webworker, electron-main and electron-renderer). To run node specific tests a file named `test/node.js` should be used to require all node test files and the same thing for the other environments with a file named `test/browser.js`. |
| 19 | +All test files should be placed under `test`. Individual test files should end in `.spec.js` or `.spec.ts` and will be ran in all environments (node, browser, webworker, electron-main and electron-renderer). To run node specific tests a file named `test/node.js` or `test/node.ts` should be used to require all node test files and the same thing for the other environments with a file named `test/browser.js` or `test/browser.ts`. |
22 | 20 |
|
23 | 21 | Your `package.json` should have the following entries and should pass `aegir lint-package-json`.
|
24 | 22 |
|
25 |
| - |
26 | 23 | ```json
|
27 | 24 | "main": "src/index.js",
|
28 | 25 | "files": [
|
@@ -80,7 +77,7 @@ Aegir can be fully configured using a config file named `.aegir.js` or the packa
|
80 | 77 | ```js
|
81 | 78 | // file: .aegir.js
|
82 | 79 |
|
83 |
| -'use strict' |
| 80 | + |
84 | 81 |
|
85 | 82 | /** @type {import('aegir').PartialOptions} */
|
86 | 83 | module.exports = {
|
|
0 commit comments