Skip to content

Commit

Permalink
Merge pull request #26 from farm-fe/fix/update-readme
Browse files Browse the repository at this point in the history
chore: update yaml plugin name
  • Loading branch information
Maidang1 authored Jul 4, 2024
2 parents e4834bd + 0985ade commit 11a5bea
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| --------------------------------------------- | ------------------------------------------------------------------------------ |
| [dsv](packages/dsv) | Converts `.csv` and `.tsv` files into JavaScript modules |
| [image](packages/image) | Imports JPG, PNG, GIF, SVG, and WebP files |
| [yml](packages/yaml) | Convert YAML files to ES6 modules |
| [yaml](packages/yaml) | Convert YAML files to ES6 modules |
| [react-components](packages/react-components) | On-demand components auto importing for React |
| [strip](packages/strip) | Remove `debugger` statements and functions like `assert.equal` from your code. |
| [url](packages/url) | Imports files as data-URIs or ES Modules. |
Expand Down
2 changes: 1 addition & 1 deletion packages/yaml/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
edition = "2021"
name = "farmfe_plugin_yml"
name = "farmfe_plugin_yaml"
version = "0.0.1"

[lib]
Expand Down
6 changes: 3 additions & 3 deletions packages/yaml/package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "@farmfe/plugin-yml",
"name": "@farmfe/plugin-yaml",
"version": "0.0.1",
"private": false,
"main": "scripts/index.js",
"types": "scripts/index.d.ts",
"type": "module",
"license": "MIT",
"napi": {
"name": "farm-plugin-yml",
"name": "farm-plugin-yaml",
"triples": {
"additional": [
"aarch64-apple-darwin",
Expand All @@ -31,7 +31,7 @@
"dev": "cargo watch -w src -s 'scripts/watch.sh'",
"bump": "npx changeset version",
"play": "pnpm --filter playground dev",
"build": "farm-plugin-tools build --platform --cargo-name farmfe_plugin_yml -p farmfe_plugin_yml --release",
"build": "farm-plugin-tools build --platform --cargo-name farmfe_plugin_yaml -p farmfe_plugin_yaml --release",
"prepublishOnly": "farm-plugin-tools prepublish"
},
"files": [
Expand Down
8 changes: 4 additions & 4 deletions packages/yaml/readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @farmfe/plugin-yml
# @farmfe/plugin-yaml

Inspired By [@rollup/plugin-yaml](https://www.npmjs.com/package/@rollup/plugin-yaml)

Expand All @@ -7,7 +7,7 @@ Inspired By [@rollup/plugin-yaml](https://www.npmjs.com/package/@rollup/plugin-y
## install

```bash
pnpm add -D @farmfe/plugin-yml
pnpm add -D @farmfe/plugin-yaml
```

## Usage
Expand All @@ -20,7 +20,7 @@ import { defineConfig } from '@farmfe/core';
export default defineConfig({
plugins: [
[
'@farmfe/plugin-yml',
'@farmfe/plugin-yaml',
{
documentMode: 'single' | 'multi', // default single
include: Regex, // default None,
Expand All @@ -31,6 +31,6 @@ export default defineConfig({
});
```

notice:
*notice:*

include or exclude is Regex not glob For example `**/01.yaml` is not illegal。What is right is like `".*\\/01.yaml"`

0 comments on commit 11a5bea

Please sign in to comment.