mirror of
https://github.com/any86/any-rule.git
synced 2025-07-14 15:38:58 +08:00
100 lines
3.5 KiB
JavaScript
100 lines
3.5 KiB
JavaScript
const fs = require('fs');
|
|
const chalk = require('chalk');
|
|
const json = require('../packages/www/src/RULES');
|
|
const VSC_URL = 'https://marketplace.visualstudio.com/items?itemName=russell.any-rule'
|
|
const badges = [
|
|
// ``,
|
|
|
|
``,
|
|
|
|
|
|
`[](https://marketplace.visualstudio.com/items?itemName=russell.any-rule)`,
|
|
|
|
`[](https://marketplace.visualstudio.com/items?itemName=russell.any-rule)`,
|
|
|
|
`[](https://marketplace.visualstudio.com/items?itemName=russell.any-rule)`,
|
|
|
|
``,
|
|
|
|
`[](https://circleci.com/gh/any86/any-rule)`
|
|
|
|
// vscode上传不让用svg
|
|
// `[](https://github.com/any86/any-rule/actions)`
|
|
];
|
|
|
|
let content = `# 正则大全 ${badges.join(' ')}
|
|
|
|
支持**web** / **vscode插件**2种查询方式.
|
|
|
|
## :rocket:web版本
|
|
https://any86.github.io/any-rule/
|
|
|
|
## 🍭vscode插件
|
|
### 安装
|
|
vscode应用商店中搜索"**any-rule**".
|
|
|
|
### 使用
|
|
**方式1:**
|
|
1. 安装完毕后按**F1**(或者ctrl+shift+p).
|
|
2. 输入"**zz**"弹出正则列表.
|
|
3. **输入关键词搜索**, 比如"手机".
|
|
|
|
|
|
|
|
**方式2:**
|
|
|
|
1. 在代码的任意位置输入"**zz.**"弹出正则列表.
|
|
2. **输入关键词搜索**, 比如"手机".
|
|
|
|
|
|
|
|
## 🦕图解正则
|
|
在vscode中选择正则后, 可点击"🦕图解正则".
|
|
|
|
|
|
|
|
点击后可以看到正则解析, 方便大家学习.
|
|
|
|
|
|
|
|
**注意**: 图解直接使用了https://regexper.com, 在此对作者表示敬意和感谢.
|
|
|
|
## :fire:关于PR
|
|
欢迎大家PR, 步骤如下:
|
|
1. **正则**请在**packages/www/src/RULES.js**中添加.
|
|
2. 运行\`npm run test:rules\`进行测试.
|
|
3. 运行\`npm run build:md\`更新**README.md**.
|
|
4. 请务必提交到**develop**分支.
|
|
|
|
在此感谢大家对**any-rule**做出的贡献!
|
|
|
|
## 👽主要开发者
|
|
按照加入时间排序
|
|
<table>
|
|
<tr>
|
|
<td>
|
|
<a href="https://github.com/MrTenger"><img width="60" src="https://avatars3.githubusercontent.com/u/10781715?s=60&v=4"></a>
|
|
</td>
|
|
<td>
|
|
<a href="https://github.com/giraffeComing"><img width="60" src="https://avatars2.githubusercontent.com/u/14800669?s=460&v=4"></a>
|
|
</td>
|
|
<td>
|
|
<a href="https://github.com/microud"><img width="60" src="https://avatars1.githubusercontent.com/u/10163257?s=60&v=4"></a>
|
|
</td>
|
|
<td>
|
|
<a href="https://github.com/52cik"><img width="60" src="https://avatars0.githubusercontent.com/u/5033310?s=60&v=4"></a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
## 🍔正则
|
|
`;
|
|
|
|
json.forEach(({title, rule})=>{
|
|
content+= `\r\n### ${title}\r\n`;
|
|
content+= `\`\`\`javascript\r\n`;
|
|
content+= `${rule}\r\n\`\`\`\r\n`;
|
|
});
|
|
fs.writeFileSync('./README.md',content,'utf-8');
|
|
console.log(chalk.green('生成完毕'));
|