https://github.com/wenyan-lang/wyg

文淵閣 Package manager for wenyan-lang
https://github.com/wenyan-lang/wyg

npm packages-manager wenyan wenyan-lang wyg

Last synced: 3 months ago
JSON representation

文淵閣 Package manager for wenyan-lang

• Host: GitHub
• URL: https://github.com/wenyan-lang/wyg
• Owner: wenyan-lang
• License: mit
• Created: 2020-01-09T05:14:19.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T04:58:18.000Z (about 2 years ago)
• Last Synced: 2024-10-28T10:04:07.537Z (3 months ago)
• Topics: npm, packages-manager, wenyan, wenyan-lang, wyg
• Language: TypeScript
• Homepage:
• Size: 554 KB
• Stars: 38
• Watchers: 6
• Forks: 4
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 文淵閣 - Package management for wenyan-lang

[![npm](https://img.shields.io/npm/v/@wenyan/wyg)](https://www.npmjs.com/package/@wenyan/wyg)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/wenyan-lang/wyg/Test)](https://github.com/wenyan-lang/wyg/actions)

[wyg](https://github.com/wenyan-lang/wyg)(wenyan-get, or 文淵閣) is a package manager for wenyan-lang. Just like [`npm`](https://www.npmjs.com/) for Node.js or [`pip`](https://pip.pypa.io/en/stable/) for Python.

## Install 

```bash

npm i -g @wenyan/wyg

```

## Example Usage

```bash

wyg i ziyue

```

Chinese names are also acceptable

s

```bash

wyg i 子曰

```

The command above will download the package [`子曰`](https://github.com/antfu/ziyue-wy) to `藏書樓/子曰` of cwd. You can think of `藏書樓` as the wenyan version of `node_modules`. 

> 💡 You may want to include `藏書樓` into your `.gitignore` as well

Then write code and import the package as you always do

```

吾嘗觀「「子曰」」之書。方悟「子曰」之義。

子曰「「巧言令色，鮮矣仁！」」。

```

> 💬 Importing from `藏書樓` is only supported by Wenyan v0.2.2 or above.

### Publish Your Own Packages

Please following [the instruction in wyg-registry](https://github.com/wenyan-lang/wyg-registry).

### Use wyg in browser

You can fetch the package information by

```html

```

```js

Wyg.resolve('ziyue')

  .then(({ name, entry, author, repo }) => {

    console.log(name, entry)

  })

```

Output:

```

子曰 https://raw.githubusercontent.com/antfu/ziyue-wy/master/序.wy

```

### Direct import

You can access packages with Urls this format. It will redirect to the package repo's `序.wy` file.

```

https://wyg.wy-lang.org/pkg/

```

For example, the following two links are both acceptable.

```

https://wyg.wy-lang.org/pkg/ziyue

https://wyg.wy-lang.org/pkg/子曰

```

If you want to use packages in [Browser Runtime](https://github.com/wenyan-lang/wenyan/wiki/Browser-Runtime), you can import them by:

```html

```

## License

[MIT License](https://github.com/wenyan-lang/wyg/blob/master/LICENSE) © 2020 [Anthony Fu](https://github.com/antfu)