Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ipfs/aegir
AEgir - Automated JavaScript project building
https://github.com/ipfs/aegir
aegir coverage esbuild linting testing typescript
Last synced: 1 day ago
JSON representation
AEgir - Automated JavaScript project building
- Host: GitHub
- URL: https://github.com/ipfs/aegir
- Owner: ipfs
- License: other
- Created: 2016-03-20T21:21:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T10:51:23.000Z (9 days ago)
- Last Synced: 2024-10-29T12:11:28.567Z (9 days ago)
- Topics: aegir, coverage, esbuild, linting, testing, typescript
- Language: JavaScript
- Homepage: https://ipfs.github.io/aegir
- Size: 8.15 MB
- Stars: 97
- Watchers: 23
- Forks: 60
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://ipfs.tech)
[](https://discuss.ipfs.tech)
[](https://codecov.io/gh/ipfs/aegir)
[](https://github.com/ipfs/aegir/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
> JavaScript project management
## Install
```console
$ npm i aegir
```
### Browser `` tag
Loading this module through a script tag will make its exports available as `Aegir` in the global namespace.
```html
<script src="https://unpkg.com/aegir/dist/index.min.js">
```
## Project Structure
The project structure when using this is quite strict, to ease replication and configuration overhead.
All source code should be placed under `src`, with the main entry point being `src/index.js` or `src/index.ts`.
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`.
Your `package.json` should have the following entries and should pass `aegir lint-package-json`.
```json
"main": "src/index.js",
"files": [
"src",
"dist"
],
"scripts": {
"lint": "aegir lint",
"release": "aegir release",
"build": "aegir build",
"test": "aegir test",
"test:node": "aegir test --target node",
"test:browser": "aegir test --target browser"
}
```
## CLI
Run `aegir --help`
```bash
Usage: aegir [options]
Commands:
aegir completion generate completion script
aegir build Builds a browser bundle and TS type declara
tions from the `src` folder.
aegir check-project Ensure your project has the correct config.
aegir check Check project
aegir clean [files..] Remove created build artifacts.
aegir dependency-check [input...] Run `dependency-check` cli with aegir defau
lts. [aliases: dep-check, dep]
aegir docs Generate documentation from TS type declara
tions.
aegir document-check [input...] Run `document-check` cli with aegir default
s. [aliases: doc-check]
aegir lint-package-json Lint package.json with aegir defaults.
[aliases: lint-package, lpj]
aegir lint Lint all project files
aegir release Release using semantic-release
aegir release-rc Release an RC version of the current module
or monorepo
aegir test-dependant [repo] Run the tests of an module that depends on
this module to see if the current changes h
ave caused a regression
aegir test Test your code in different environments
aegir exec Run a command in each project of a monorepo
aegir run Run one or more npm scripts in each project
of a monorepo
Global Options:
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
-d, --debug Show debug output. [boolean] [default: false]
Examples:
aegir build Runs the build command to bundle JS
code for the browser.
npx aegir build Can be used with `npx` to use a loca
l version
aegir test -t webworker -- --browser fir If the command supports `--` can be
efox used to forward options to the under
lying tool.
npm test -- -- --browser firefox If `npm test` translates to `aegir t
est -t browser` and you want to forw
ard options you need to use `-- --`
instead.
Use `aegir --help` to learn more about each command.
```
## Configuration
Aegir can be fully configured using a config file named `.aegir.js` or the package.json using the property `aegir`.
```js
// file: .aegir.js
/** @type {import('aegir').PartialOptions} */
module.exports = {
tsRepo: true,
release: {
build: false
}
}
```
```json
// file: package.json
"main": "src/index.js",
"files": [
"src",
"dist"
],
"scripts": {
"lint": "aegir lint",
"release": "aegir release",
"build": "aegir build",
"test": "aegir test",
"test:node": "aegir test --target node",
"test:browser": "aegir test --target browser"
},
"aegir" : {
"tsRepo": false
}
```
You can find the complete default config [here](https://github.com/ipfs/aegir/blob/master/src/config/user.js#L12) and the types [here](https://github.com/ipfs/aegir/blob/master/src/types.d.ts).
## Continuous Integration
Check this template for Github Actions
## Testing helpers
In addition to running the tests `aegir` also provides several helpers to be used by the tests.
Check the [documentation](https://ipfs.github.io/aegir/)
## Typescript
Aegir will detect the presence of `tsconfig.json` files and build typescript as appropriate.
## Release steps
1. Run linting
2. Run type check
3. Run tests
4. Bump the version in `package.json`
5. Build everything
6. Update contributors based on the git history
7. Generate a changelog based on the git log
8. Commit the version change & `CHANGELOG.md`
9. Create a git tag
10. Run `git push` to `origin/master`
11. Publish a release to Github releases
12. Generate documentation and push to Github Pages
13. Publish to npm
```bash
aegir release --help
```
## API Docs
-
## License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )
- MIT ([LICENSE-MIT](LICENSE-MIT) / )
## Contribute
Contributions welcome! Please check out [the issues](https://github.com/ipfs/aegir/issues).
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)