Skip to content

Commit

Permalink
Update links
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdima committed Nov 16, 2021
1 parent 97da96f commit 903a92c
Show file tree
Hide file tree
Showing 8 changed files with 224 additions and 28 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ jobs:
- name: Run unit tests
run: npm test

- name: Build webpack plugin
- name: Compile webpack plugin
run: npm run compile --prefix webpack-plugin

- name: Package using webpack plugin
Expand Down
37 changes: 22 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,20 +54,32 @@ You need to have all the build setup of VS Code to be able to build the Monaco E
# install npm deps for monaco-editor
/src/monaco-editor> npm install .

# compile all plugins
# compile and bundle all plugins
/src/monaco-editor> npm run release

# start a local http server in the background
/src/monaco-editor> npm run simpleserver
```

Open [http://localhost:8080/monaco-editor/test/?editor=src](http://localhost:8080/monaco-editor/test/?editor=src) to run.
Open [http://localhost:8080/monaco-editor/test/manual/?editor=src](http://localhost:8080/monaco-editor/test/manual/?editor=src) to run.

## Running the editor tests

```bash
/src/vscode> npm run monaco-editor-test
# or run a test page http://localhost:8080/monaco-editor/test/?editor=src
# create a local release
/src/monaco-editor> npm run release

# run unit tests
/src/monaco-editor> npm run test

# compile the webpack plugin
/src/monaco-editor> npm run compile --prefix webpack-plugin

# package using the webpack plugin
/src/monaco-editor> npm run smoketest --prefix webpack-plugin

# run the smoketest
/src/monaco-editor> npm run smoketest-debug
```

> Tip: All folders must be cloned as siblings.
Expand Down Expand Up @@ -106,7 +118,7 @@ Open [http://localhost:8080/monaco-editor/test/?editor=src](http://localhost:808
- generate npm package `/src/vscode> yarn gulp editor-distro`
- publish npm package `/src/vscode/out-monaco-editor-core> npm publish`

#### 2. Update `monaco-editor-core`
#### 2. Adopt new `monaco-editor-core` version

- edit `/src/monaco-editor/package.json` and update the version of [`monaco-editor-core`](https://www.npmjs.com/package/monaco-editor-core)

Expand All @@ -117,33 +129,28 @@ Open [http://localhost:8080/monaco-editor/test/?editor=src](http://localhost:808

#### 4. Generate and try out the local release

- `/src/monaco-editor> npm run release`
- try as many test pages as you think are relevant. e.g.:
- open `http://localhost:8080/monaco-editor/test/?editor=releaseDev`
- open `http://localhost:8080/monaco-editor/test/?editor=releaseMin`
- open `http://localhost:8080/monaco-editor/test/smoketest.html?editor=releaseDev`
- open `http://localhost:8080/monaco-editor/test/smoketest.html?editor=releaseMin`
- run the editor smoketest via CI or [manually](#running-the-editor-tests).

#### 5. Update release note.

- API Change/Breaking Change/New and noteworthy
- API Changes / Breaking Changes / New and noteworthy
- Thank you ([use this tool](https://vscode-tools.azurewebsites.net/))

#### 6. Publish

- `/src/monaco-editor> npm version minor`
- `/src/monaco-editor> npm run release`
- `/src/monaco-editor/release> npm publish`
- `/src/monaco-editor> git push --tags`
- `/src/monaco-editor> git push origin v0.50.0`

#### 7. Update Website

- `/src/monaco-editor> npm run website`

#### 8. Publish new webpack plugin

- https://github.com/microsoft/monaco-editor-webpack-plugin
- update to latest `monaco-editor`
- **TBD**
- https://github.com/microsoft/monaco-editor/tree/main/webpack-plugin
- `npm install .`
- `npm run import-editor`
- if there are no changes generated after the script:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ It is recommended to develop against the `dev` version, and in production to use
- [Integrate the AMD version](./docs/integrate-amd.md).
- [Integrate the ESM version](./docs/integrate-esm.md)
- Learn how to use the editor API and try out your own customizations in the [playground](https://microsoft.github.io/monaco-editor/playground.html).
- Explore the [API docs](https://microsoft.github.io/monaco-editor/api/index.html) or read them straight from [`monaco.d.ts`](https://github.com/Microsoft/monaco-editor/blob/gh-pages/playground/monaco.d.ts.txt).
- Read [this guide](https://github.com/Microsoft/monaco-editor/wiki/Accessibility-Guide-for-Integrators) to ensure the editor is accessible to all your users!
- Explore the [API docs](https://microsoft.github.io/monaco-editor/api/index.html) or read them straight from [`monaco.d.ts`](https://github.com/microsoft/monaco-editor/blob/main/website/typedoc/monaco.d.ts).
- Read [this guide](https://github.com/microsoft/monaco-editor/wiki/Accessibility-Guide-for-Integrators) to ensure the editor is accessible to all your users!
- Create a Monarch tokenizer for a new programming language [in the Monarch playground](https://microsoft.github.io/monaco-editor/monarch.html).
- Ask questions on [StackOverflow](https://stackoverflow.com/questions/tagged/monaco-editor)! Search open and closed issues, there are a lot of tips in there!

Expand Down
191 changes: 190 additions & 1 deletion ThirdPartyNotices.txt

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/integrate-amd.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Here is the most basic HTML page that embeds the editor using AMD.

More self-contained samples are available at [monaco-editor-samples](https://github.com/Microsoft/monaco-editor-samples).
More self-contained samples are available in the [samples folder](../samples/).

```html
<!DOCTYPE html>
Expand Down
8 changes: 4 additions & 4 deletions docs/integrate-esm.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@

Here is the most basic script that imports the editor using ESM with webpack.

More self-contained samples are available at [monaco-editor-samples](https://github.com/Microsoft/monaco-editor-samples).
More self-contained samples are available in the [samples folder](../samples/).

---

### Option 1: Using the Monaco Editor WebPack Plugin

This is the easiest method, and it allows for options to be passed into the plugin in order to select only a subset of editor features or editor languages. Read more about the [Monaco Editor WebPack Plugin](https://github.com/Microsoft/monaco-editor-webpack-plugin), which is a community authored plugin.
This is the easiest method, and it allows for options to be passed into the plugin in order to select only a subset of editor features or editor languages. Read more about the [Monaco Editor WebPack Plugin](../webpack-plugin/), which is a community authored plugin.

- `index.js`

Expand Down Expand Up @@ -61,7 +61,7 @@ module.exports = {

### Option 2: Using plain webpack

Full working samples are available at https://github.com/Microsoft/monaco-editor-samples/tree/master/browser-esm-webpack or https://github.com/Microsoft/monaco-editor-samples/tree/master/browser-esm-webpack-small
Full working samples are available at https://github.com/microsoft/monaco-editor/tree/main/samples/browser-esm-webpack or https://github.com/microsoft/monaco-editor/tree/main/samples/browser-esm-webpack-small

- `index.js`

Expand Down Expand Up @@ -134,7 +134,7 @@ module.exports = {

### Using parcel

A full working sample is available at https://github.com/Microsoft/monaco-editor-samples/tree/master/browser-esm-parcel
A full working sample is available at https://github.com/microsoft/monaco-editor/tree/main/samples/browser-esm-parcel

When using parcel, we need to use the `getWorkerUrl` function and build the workers seperately from our main source. To simplify things, we can write a tiny bash script to build the workers for us.

Expand Down
2 changes: 1 addition & 1 deletion webpack-plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Monaco Editor Webpack Loader Plugin

A plugin to simplify loading the [Monaco Editor](https://github.com/Microsoft/monaco-editor) with [webpack](https://webpack.js.org/).
A plugin to simplify loading the [Monaco Editor](https://github.com/microsoft/monaco-editor) with [webpack](https://webpack.js.org/).

## Installing

Expand Down
6 changes: 3 additions & 3 deletions webpack-plugin/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/microsoft/monaco-editor-webpack-plugin.git"
"url": "git+https://github.com/microsoft/monaco-editor.git"
},
"keywords": [
"webpack",
Expand All @@ -25,9 +25,9 @@
"author": "Microsoft Corporation",
"license": "MIT",
"bugs": {
"url": "https://github.com/microsoft/monaco-editor-webpack-plugin/issues"
"url": "https://github.com/microsoft/monaco-editor/issues"
},
"homepage": "https://github.com/microsoft/monaco-editor-webpack-plugin#readme",
"homepage": "https://github.com/microsoft/monaco-editor#readme",
"peerDependencies": {
"webpack": "^4.5.0 || 5.x",
"monaco-editor": "0.30.x"
Expand Down

0 comments on commit 903a92c

Please sign in to comment.