Skip to content

Commit e3a4b45

Browse files
authoredApr 7, 2022
feat: update build and release commands (#946)
* Release command now runs `semantic-release` * Build command runs `tsc` * Dual ESM/CJS support is dropped - ESM is now ESM and CJS is CJS * Adds `clean` command * Updates all deps * `aegir.js` config files can now be ESM * ts tests are now loaded by default * Adds `check-project` command to ensure correct config for aegir projects * Converts project to esm * Exports chai at `aegir/utils/chai` BREAKING CHANGE: ESM modules are now published as ESM and not dual-ESM/CJS
1 parent 585b004 commit e3a4b45

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+2149
-1695
lines changed
 

‎.aegir.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/** @type {import("./src/types").PartialOptions} */
2-
module.exports = {
2+
export default {
33
docs: {
44
entryPoint: 'utils'
55
}

‎README.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,25 @@
1-
# AEgir
2-
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
3-
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.io/)
1+
# AEgir
2+
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
3+
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.io/)
44
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
55
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/ipfs/aegir/ci/master?style=flat-square)
66

77
> Automated JavaScript project management.
88
9-
## Lead Maintainer
9+
## Lead Maintainer
1010

1111
[Hugo Dias](https://github.com/hugomrdias)
1212

1313
## Project Structure
1414

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.
1716

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`.
2018

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`.
2220

2321
Your `package.json` should have the following entries and should pass `aegir lint-package-json`.
2422

25-
2623
```json
2724
"main": "src/index.js",
2825
"files": [
@@ -80,7 +77,7 @@ Aegir can be fully configured using a config file named `.aegir.js` or the packa
8077
```js
8178
// file: .aegir.js
8279

83-
'use strict'
80+
8481

8582
/** @type {import('aegir').PartialOptions} */
8683
module.exports = {

0 commit comments

Comments
 (0)
Please sign in to comment.