Skip to content

Commit

Permalink
Fix all remaining dead links (parcel-bundler#607)
Browse files Browse the repository at this point in the history 
* All remaining dead links

* 'all'
  • Loading branch information
@mischnic
mischnic authored Jun 19, 2020
1 parent 6406b3c commit 9f173e3
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 39 deletions.
10 changes: 10 additions & 0 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,22 @@
"@babel/parser": "^7.10.2",
"@babel/traverse": "^7.10.1",
"eleventy-plugin-sass": "^1.0.0",
"husky": "^4.2.5",
"lint-staged": "^10.2.11",
"markdown-it": "^11.0.0",
"markdown-it-anchor": "^5.3.0",
"prettier": "^2.0.5"
},
"dependencies": {
"flow-bin": "^0.127.0",
"nullthrows": "^1.1.1"
},
"lint-staged": {
"*.{md,scss,json}": "prettier --write"
},
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
}
}
26 changes: 13 additions & 13 deletions src/configuration/package-json.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,18 +132,18 @@ Each of those targets contains the target's environment configuration (all of th

<div style="font-size: 0.9em">

| Option | Possible values | Description |
| -------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `context` | [see below](#context) | In which runtime the bundles should run. |
| `distDir` | `string` | Specify output folder (as opposed to output file) |
| `engines` | [`package.json#engines`](#engines-%2F-browserslist) | Higher priority than `package.json#engines` |
| `includeNodeModules` | [see below](#includenodemodules) | Whether to bundle all/none/some `node_module` dependencies |
| `isLibrary` | `boolean` | Library as in "npm library" |
| `minify` | `boolean` | Whether to enable minification (exact behaviour is determined by plugins). <br> Set by [`--no-minify`](/getting-started/cli/#parameters-specific-to-build) |
| `outputFormat` | `'global' | 'esmodule' | 'commonjs'` | Which type of imports/exports should be emitted |
| `publicUrl` | `string` | The public url of the bundle at runtime |
| `scopeHoist` | `boolean` | Whether to enable scope hoisting <br> Needs to be `true` for ESM and CommonJS `outputFormat`. <br> Set by [`--no-scope-hoist`](/getting-started/cli/#parameters-specific-to-build) |
| `sourceMap` | [see below](#sourcemap) | Enable/disable sourcemap and set options. <br> Overwritten by [`--no-source-maps`](/getting-started/cli/#general-parameters) |
| Option | Possible values | Description |
| -------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `context` | [see below](#context) | In which runtime the bundles should run. |
| `distDir` | `string` | Specify output folder (as opposed to output file) |
| `engines` | [`package.json#engines`](#engines-%2F-browserslist) | Higher priority than `package.json#engines` |
| `includeNodeModules` | [see below](#includenodemodules) | Whether to bundle all/none/some `node_module` dependencies |
| `isLibrary` | `boolean` | Library as in "npm library" |
| `minify` | `boolean` | Whether to enable minification (exact behaviour is determined by plugins). <br> Set by [`--no-minify`](/features/cli/#parameters-specific-to-build) |
| `outputFormat` | `'global' | 'esmodule' | 'commonjs'` | Which type of imports/exports should be emitted |
| `publicUrl` | `string` | The public url of the bundle at runtime |
| `scopeHoist` | `boolean` | Whether to enable scope hoisting <br> Needs to be `true` for ESM and CommonJS `outputFormat`. <br> Set by [`--no-scope-hoist`](/features/cli/#parameters-specific-to-build) |
| `sourceMap` | [see below](#sourcemap) | Enable/disable sourcemap and set options. <br> Overwritten by [`--no-source-maps`](/features/cli/#general-parameters) |

</div>

Expand Down Expand Up @@ -205,7 +205,7 @@ Can be a boolean (to simply enable / disable source maps) or an option (which is
| inlineSources | `false` | Should the sourcemap contain the sources contents (otherwise, they will be loaded from `${sourceRoot}/$(name)`) |
| sourceRoot | `path.relative(bundle, pojectRoot)` | Essentially the public url for the sources |

The [--no-source-maps](getting-started/cli/#general-paramaters) CLI parameter sets the default value to `false` (as opposed to `true`).
The [--no-source-maps](/features/cli/#general-parameters) CLI parameter sets the default value to `false` (as opposed to `true`).

#### `engines` / `browserslist`

Expand Down
2 changes: 1 addition & 1 deletion src/features/node-emulation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Notably:

## 🕳️ Polyfilling & Excluding Builtin Node Modules

When (or more likely a dependency) importing packages such as `crypto`, `fs` or `process`, Parcel will either automatically use one of the listed polyfills and otherwise exclude that module. You can use [the `alises` field in your `package.json`](/getting-started/module-resolution/#aliases)
When (or more likely a dependency) importing packages such as `crypto`, `fs` or `process`, Parcel will either automatically use one of the listed polyfills and otherwise exclude that module. You can use [the `aliases` field in your `package.json`](/features/module-resolution/#aliases)

| native module | npm replacement | native module | npm replacement |
| ------------- | -------------------------- | -------------- | -------------------- |
Expand Down
9 changes: 0 additions & 9 deletions src/getting-started/webapp.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,3 @@ render(<h1>Hello World</h1>, document.getElementById("root"));

{% endsamplefile %}
{% endsample %}

### Configuring Parcel

When you do need to configure Parcel, it will be in one of 3 places.

- If you need to configure the CLI, it will be a [CLI flag](cli/)
- If you need to configure your package, it will be in the [`package.json`](configuraiton/)
- If you need to configure something with your files or the Parcel asset
pipeline, it will be in [`.parcelrc`](plugin-config/)
8 changes: 4 additions & 4 deletions src/languages/postcss.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ eleventyNavigation:

To motivate some of the following tips, here's an overview over how Parcel processes CSS files (in that order):

- [@parcel/transformer-postcss](/official-plugins/transformer-postcss/):
- `@parcel/transformer-postcss`:
Applies `.postcssrc` and might generate a CSS modules map
- [@parcel/transformer-css](/official-plugins/transformer-css/):
- `@parcel/transformer-css`:
Registers `@import ...` and `url(...)` into Parcel's graph
- [@parcel/packager-css](/official-plugins/packager-css/):
- `@parcel/packager-css`:
Concat all CSS assets into a single bundle.
- [@parcel/optimizer-cssnano](/official-plugins/optimizer-cssnano/):
- `@parcel/optimizer-cssnano`:
Minify the bundle output from `@parcel/packager-css`.

As you can see, each asset is processed individually by PostCSS and concatenated with the others afterwards.
Expand Down
2 changes: 1 addition & 1 deletion src/languages/typescript.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ If you are using more advanced TypeScript features that include custom config se
{% endsamplefile %}
{% endsample %}

Because Parcel processes each file individually, it implicitly sets `isolatedModules: true` in the tsc options, this [comes with limitations as well](https://www.typescriptlang.org/tsconfig#isolatedModules), namely constant `const enum`s not being supported either.
Because Parcel processes each file individually, it implicitly sets `isolatedModules: true` in the tsc options, this comes with limitations as well, namely constant `const enum`s not being supported either.

- No type checking
- `const enum` isn't supported
Expand Down
2 changes: 1 addition & 1 deletion src/plugin-system/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ eleventyNavigation:
summary: "Not really a plugin type: A reuseable '.parcelrc' package"
---

This is simply a [`.parcelrc`](/getting-started/plugin-config/) file wrapped into a published package, the `main` points to the config file.
This is simply a [`.parcelrc`](/configuration/plugin-configuration/) file wrapped into a published package, the `main` points to the config file.

```json
{
Expand Down
20 changes: 10 additions & 10 deletions src/plugin-system/overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,26 +65,26 @@ separate bundles. For example, if your `index.html` file links to an

### Complete List of Plugin Types (in a somewhat correct order)

- [Transformer](transformer): Converts an asset (into another asset) <br>
- [Transformer](/plugin-system/transformer): Converts an asset (into another asset) <br>
_Example: convert Typescript to Javascript (per file)_
- [Resolver](resolver): Turns dependency requests into absolute paths (or exclude them) <br>
- [Resolver](/plugin-system/resolver): Turns dependency requests into absolute paths (or exclude them) <br>
_Example: add your own syntax for imports, e.g. `import "^/foo"`_
- [Bundler](bundler): Turns an asset graph into a bundle graph <br>
- [Bundler](/plugin-system/bundler): Turns an asset graph into a bundle graph <br>
_Example: create a bundler that does Vendoring (splitting app and node_modules code)_
- [Namer](namer): Generates a filename (or filepath) for a bundle <br>
- [Namer](/plugin-system/namer): Generates a filename (or filepath) for a bundle <br>
_Example: create a bundler that does Vendoring (splitting app and node_modules code)_
- [Runtime](runtime): Programatically inserts (synthetic) assets into bundles" <br>
- [Runtime](/plugin-system/runtime): Programatically inserts (synthetic) assets into bundles" <br>
_Example: add analytics to every bundle_
- [Packager](packager): Turns a group of assets (bundle) into a bundle file" <br>
- [Packager](/plugin-system/packager): Turns a group of assets (bundle) into a bundle file" <br>
_Example: concatenate all input CSS files into a CSS bundle_
- [Optimizer](optimizer): Applies modifications to the finished bundle (similar to a transformer) <br>
- [Optimizer](/plugin-system/optimizer): Applies modifications to the finished bundle (similar to a transformer) <br>
_Example: run a minifier or convert into a data-url for inline usage_

<p></p> <!-- Force two lists -->

- [Validator](validator): Analyzes assets and emit warnings and errors <br>
- [Validator](/plugin-system/validator): Analyzes assets and emit warnings and errors <br>
_Example: do type-checking (Typescript, Flow)_
- [Config](config): A reuseable '.parcelrc' package <br>
- [Config](/plugin-system/configuration): A reuseable '.parcelrc' package <br>
_Example: provide a tailor-made parcel config for your boilerplate_ <br>
- [Reporter](reporter): Listens to events of the build <br>
- [Reporter](/plugin-system/reporter): Listens to events of the build <br>
_Example: generate a bundle report, run a dev server_

0 comments on commit 9f173e3

Please sign in to comment.