Skip to content

Commit 2874e9a

Browse files
committed
more dist vs build cleaning, and documentation update
1 parent 42a1ebd commit 2874e9a

File tree

4 files changed

+6
-23
lines changed

4 files changed

+6
-23
lines changed

CONTRIBUTING.md

+2-12
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,8 @@ Then build the melonJS source by running:
2323
$ npm run build
2424

2525
The generated files will be available under the `build` directory :
26-
- `melonjs.module.js` : plain ES6 module
27-
- `melonjs.mjs` : a ES6 chunk directory used for tree-shaking
28-
29-
If you need to create the corresponding typing you can use the follwing :
30-
31-
$ npm run types
32-
33-
This will generate all the `.d.ts` file under the `dist/types` directory.
26+
- `index.js` : a tree-shakeable ES6 Module Directory
27+
- `index.d.ts` : typescript declaration files
3428

3529
To run the melonJS test suite simply use the following:
3630

@@ -47,10 +41,6 @@ Similarly, you can build your own copy of the docs locally by running :
4741

4842
The documentation will be generated under the `docs` directory, and can be accessed by opening index.html in your web browser.
4943

50-
## WIP Builds
51-
52-
latest WIP builds are available under [`dist`](dist/) in the [master](https://github.com/melonjs/melonJS/tree/master) branch.
53-
5444
## Questions, need help ?
5545

5646
If you need technical support, you can contact us through the following channels :

README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,8 @@ melonJS 2 now only provides an ES6 Bundle :
173173

174174
| build | description |
175175
| ------------------- | ----------- |
176-
| `melonjs.module.js` | the ES6 Module (ESM) Bundle |
177-
| `melonjs.mjs` | a tree-shakeable ES6 Module Directory |
178-
| `types/index.d.ts` | typescript declaration files for the ES6 Module (ESM) Bundle |
176+
| `index.js` | a tree-shakeable ES6 Module Directory |
177+
| `index.d.ts` | typescript declaration files |
179178

180179
>Note: if you need your application to be compatible with ES5, refer to our [boilerplate](#using-melonjs) that provides automatic transpiling to ES5.
181180

biome.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"enabled": false
55
},
66
"files": {
7-
"ignore": ["docs/", "dist/", "build/", "tests/browser/public/lib"]
7+
"ignore": ["docs/", "build/", "tests/browser/public/lib"]
88
},
99
"formatter": { "enabled": true },
1010
"linter": { "enabled": false }

eslint.config.mjs

+1-7
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,7 @@ export default tseslint.config(
99
{
1010
name: "eslint/global-ignores",
1111
// globally ignore below directories and files
12-
ignores: [
13-
"dist/**/*",
14-
"build",
15-
"docs/**/*",
16-
"rollup.config.mjs",
17-
"scripts/build.js",
18-
],
12+
ignores: ["build", "docs/**/*", "rollup.config.mjs", "scripts/build.js"],
1913
},
2014
{
2115
name: "eslint/global-rules",

0 commit comments

Comments
 (0)