From 9d5273de83441d780db69f78a95c3f7d7f7bd2a2 Mon Sep 17 00:00:00 2001 From: Louis Gollut Date: Tue, 4 Jul 2023 17:05:04 +0200 Subject: [PATCH] chore(doc): Fix typo in documentation markdown --- packages/class-prefixer-ast-visitor/README.md | 4 +++- packages/class-prefixer-core/README.md | 2 ++ packages/esbuild-plugin-ast-vue/README.md | 12 ++++++------ packages/esbuild-plugin-ast/README.md | 4 ++-- packages/postcss-class-prefixer/README.md | 5 +++++ 5 files changed, 18 insertions(+), 9 deletions(-) diff --git a/packages/class-prefixer-ast-visitor/README.md b/packages/class-prefixer-ast-visitor/README.md index 71f754f..91ebbd1 100644 --- a/packages/class-prefixer-ast-visitor/README.md +++ b/packages/class-prefixer-ast-visitor/README.md @@ -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 @@ -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 diff --git a/packages/class-prefixer-core/README.md b/packages/class-prefixer-core/README.md index b7e6905..a7f3142 100644 --- a/packages/class-prefixer-core/README.md +++ b/packages/class-prefixer-core/README.md @@ -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 diff --git a/packages/esbuild-plugin-ast-vue/README.md b/packages/esbuild-plugin-ast-vue/README.md index c17cdf8..a640cf1 100644 --- a/packages/esbuild-plugin-ast-vue/README.md +++ b/packages/esbuild-plugin-ast-vue/README.md @@ -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 @@ -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 diff --git a/packages/esbuild-plugin-ast/README.md b/packages/esbuild-plugin-ast/README.md index 293b0b2..eed7062 100644 --- a/packages/esbuild-plugin-ast/README.md +++ b/packages/esbuild-plugin-ast/README.md @@ -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 @@ -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. diff --git a/packages/postcss-class-prefixer/README.md b/packages/postcss-class-prefixer/README.md index 4ee6425..7073120 100644 --- a/packages/postcss-class-prefixer/README.md +++ b/packages/postcss-class-prefixer/README.md @@ -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 @@ -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