100 lines
3.5 KiB
JavaScript
Raw Normal View History

2019-08-02 17:23:00 +08:00
const fs = require('fs');
const chalk = require('chalk');
const json = require('../packages/www/src/RULES');
2019-08-23 22:32:01 +08:00
const VSC_URL = 'https://marketplace.visualstudio.com/items?itemName=russell.any-rule'
const badges = [
// `![](https://img.shields.io/badge/状态-积极更新-673ab7.svg)`,
2020-02-23 01:56:12 +08:00
`![已收录${json.length}条](https://img.shields.io/badge/已收录-${json.length}条-673ab7.svg)`,
2019-08-23 22:32:01 +08:00
2020-02-23 01:56:12 +08:00
`[![版本](https://badgen.net/vs-marketplace/v/russell.any-rule)](https://marketplace.visualstudio.com/items?itemName=russell.any-rule)`,
2019-08-23 22:32:01 +08:00
2020-02-23 01:56:12 +08:00
`[![安装量](https://badgen.net/vs-marketplace/i/russell.any-rule)](https://marketplace.visualstudio.com/items?itemName=russell.any-rule)`,
2019-08-23 22:32:01 +08:00
2020-02-23 01:56:12 +08:00
`[![下载量](https://badgen.net/vs-marketplace/d/russell.any-rule)](https://marketplace.visualstudio.com/items?itemName=russell.any-rule)`,
2019-08-23 22:32:01 +08:00
2020-02-23 01:56:12 +08:00
`![MIT](https://img.shields.io/badge/license-MIT-F44336.svg)`,
2019-08-23 22:32:01 +08:00
`[![CircleCI](https://badgen.net/github/status/any86/any-rule/master/ci/circleci)](https://circleci.com/gh/any86/any-rule)`
2020-02-21 22:39:58 +08:00
// vscode上传不让用svg
// `[![Node CI](https://github.com/any86/any-rule/workflows/Node%20CI/badge.svg)](https://github.com/any86/any-rule/actions)`
2019-08-23 22:32:01 +08:00
];
let content = `# 正则大全 ${badges.join(' ')}
2019-08-02 17:23:00 +08:00
2020-02-23 01:56:12 +08:00
支持**web** / **vscode**2.
2019-08-02 17:23:00 +08:00
2020-02-23 01:56:12 +08:00
## :rocket:web版本
2019-08-02 17:23:00 +08:00
https://any86.github.io/any-rule/
2019-11-20 21:58:48 +08:00
## 🍭vscode插件
2020-02-23 01:56:12 +08:00
### 安装
vscode应用商店中搜索"**any-rule**".
### 使用
**方式1:**
1. 安装完毕后按**F1**(或者ctrl+shift+p).
2020-02-23 02:34:14 +08:00
2. 输入"**zz**"弹出正则列表.
3. **输入关键词搜索**, 比如"手机".
2019-08-02 17:23:00 +08:00
2020-01-10 13:57:30 +08:00
![预览gif](https://user-gold-cdn.xitu.io/2020/1/10/16f8e01a684a0a18?w=420&h=243&f=gif&s=414162)
2019-08-02 17:23:00 +08:00
2020-02-23 01:56:12 +08:00
**方式2:**
2020-02-23 02:34:14 +08:00
1. 在代码的任意位置输入"**zz.**"弹出正则列表.
2. **输入关键词搜索**, 比如"手机".
2020-02-23 01:56:12 +08:00
![预览gif](https://user-gold-cdn.xitu.io/2020/2/23/1706df78b18466fd?w=954&h=372&f=gif&s=1732199)
2020-02-23 02:47:26 +08:00
## 🦕图解正则
在vscode中选择正则后, 可点击"🦕图解正则".
2020-02-23 03:17:23 +08:00
![预览gif](https://user-gold-cdn.xitu.io/2020/2/23/1706e32c3a6fb116?w=533&h=95&f=png&s=21563)
2020-02-23 02:47:26 +08:00
点击后可以看到正则解析, 方便大家学习.
2020-02-23 03:17:23 +08:00
![预览gif](https://user-gold-cdn.xitu.io/2020/2/23/1706e349b600c28b?w=1151&h=500&f=png&s=45210)
2020-02-23 02:47:26 +08:00
**注意**: 图解直接使用了https://regexper.com, 在此对作者表示敬意和感谢.
2019-11-20 21:58:48 +08:00
## :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**做出的贡献!
2019-10-27 13:01:46 +08:00
2020-01-10 16:20:06 +08:00
## 👽主要开发者
按照加入时间排序
<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>
2019-11-20 21:58:48 +08:00
## 🍔正则
2019-08-02 17:23:00 +08:00
`;
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');
2019-11-20 09:54:46 +08:00
console.log(chalk.green('生成完毕'));