Skip to content

Commit

Permalink
chore(doc): Fix typo in documentation markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
lgollut committed Jul 4, 2023
1 parent 45d5e57 commit 9d5273d
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 9 deletions.
4 changes: 3 additions & 1 deletion packages/class-prefixer-ast-visitor/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# class-prefixer-ast-visitor

Ready to use `ESTraverse.Visitor` implementation to prefix classes and `css` selectors. Those implementation can be use along (esbuild-plugin-ast)[] and (esbuild-plugin-ast-vue)[] plugins.
Ready to use `ESTraverse.Visitor` implementation to prefix classes and `css` selectors. Those implementation can be use along [esbuild-plugin-ast](https://github.com/liip/class-prefixer/tree/main/packages/esbuild-plugin-ast) and [esbuild-plugin-ast-vue](https://github.com/liip/class-prefixer/tree/main/packages/esbuild-plugin-ast-vue) plugins.

## createVisitor

Expand Down Expand Up @@ -52,9 +52,11 @@ type TestConditions = (string | RegExp)[];
```

**`value`**

Define the actual string used to prefix classes

**`excludes`**

Strings or regular expressions to exclude certain classes from the transformation.

### container
Expand Down
2 changes: 2 additions & 0 deletions packages/class-prefixer-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@ type TestConditions = (string | RegExp)[];
```

**`value`**

Define the actual string used to prefix classes

**`excludes`**

Strings or regular expressions to exclude certain classes from the transformation.

### container
Expand Down
12 changes: 6 additions & 6 deletions packages/esbuild-plugin-ast-vue/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# esbuild-plugin-ast

A plugin to generate an AST representation of your `.js` files. The plugin use (Acorn)[https://github.com/acornjs/acorn] to produce an `estree` compliant `AST` object. You can then apply transformations by providing a `visitor` object.
A plugin to generate an AST representation of your `.js` files. The plugin use [Acorn](https://github.com/acornjs/acorn) to produce an `estree` compliant `AST` object. You can then apply transformations by providing a `visitor` object.

## Installation

Expand Down Expand Up @@ -54,20 +54,20 @@ interface AstParserVueOptions extends AstParserOptions {

### visitor

An `ESTraverse.Visitor` object used to apply AST transformations. Check the (Estraverse documentation)[https://github.com/estools/estraverse] form more information on the available API.
An `ESTraverse.Visitor` object used to apply AST transformations. Check the [Estraverse documentation](https://github.com/estools/estraverse) form more information on the available API.

### templateVisitor

An `ESTraverse.Visitor` object used to apply AST transformations to the `JavaScript` produce by the template interpretation. Check the (Estraverse documentation)[https://github.com/estools/estraverse] form more information on the available API.
An `ESTraverse.Visitor` object used to apply AST transformations to the `JavaScript` produce by the template interpretation. Check the [Estraverse documentation](https://github.com/estools/estraverse) form more information on the available API.

### templateOptions

Template options passed to the underlying SFCCompiler. See the (`compileTemplate.ts` implementation)[https://github.com/vuejs/vue/blob/main/packages/compiler-sfc/src/compileTemplate.ts] for more details
Template options passed to the underlying SFCCompiler. See the [`compileTemplate.ts` implementation](https://github.com/vuejs/vue/blob/main/packages/compiler-sfc/src/compileTemplate.ts) for more details

### scriptOptions

Script options passed to the underlying SFCCompiler. See the (`compileScript.ts` implementation)[https://github.com/vuejs/vue/blob/main/packages/compiler-sfc/src/compileScript.ts] for more details
Script options passed to the underlying SFCCompiler. See the [`compileScript.ts` implementation](https://github.com/vuejs/vue/blob/main/packages/compiler-sfc/src/compileScript.ts) for more details

### styleOptions

Style options passed to the underlying SFCCompiler. See the (`compileStyle.ts` implementation)[https://github.com/vuejs/vue/blob/main/packages/compiler-sfc/src/compileStyle.ts] for more details
Style options passed to the underlying SFCCompiler. See the [`compileStyle.ts` implementation](https://github.com/vuejs/vue/blob/main/packages/compiler-sfc/src/compileStyle.ts) for more details
4 changes: 2 additions & 2 deletions packages/esbuild-plugin-ast/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# esbuild-plugin-ast

A plugin to generate an AST representation of your `.js` files. The plugin use (Acorn)[https://github.com/acornjs/acorn] to produce an `estree` compliant `AST` object. You can then apply transformations by providing a `visitor` object.
A plugin to generate an AST representation of your `.js` files. The plugin use [Acorn](https://github.com/acornjs/acorn) to produce an `estree` compliant `AST` object. You can then apply transformations by providing a `visitor` object.

## Installation

Expand Down Expand Up @@ -42,4 +42,4 @@ An array of node module dependencies on which this plugin should also operate.

### visitor

An `ESTraverse.Visitor` object used to apply AST transformation. Check the (Estraverse documentation)[https://github.com/estools/estraverse] form more information on the available API.
An `ESTraverse.Visitor` object used to apply AST transformation. Check the [Estraverse documentation](https://github.com/estools/estraverse) form more information on the available API.
5 changes: 5 additions & 0 deletions packages/postcss-class-prefixer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,11 @@ type TestConditions = (string | RegExp)[];
```

**`value`**

Define the actual string used to prefix classes

**`excludes`**

Strings or regular expressions to exclude certain classes from the transformation.

### container
Expand Down Expand Up @@ -172,10 +174,13 @@ type TestConditions = (string | RegExp)[];
```

**`value`**

Define the actual string used to containerize classes

**`excludes`**

An object of node types keys containing strings or regular expressions to exclude certain elements from containerization

**`preserveRoots`**

An object of node types keys containing strings or regular expressions specifying which elements should be kept at the root of the selector

0 comments on commit 9d5273d

Please sign in to comment.