30s 中文文档教程
30s
30 秒代码
片段。
Features
- Written in JavaScript (ES6)
- View, view by tag and search snippets
- Show what you find necessary by picking a layout
- Colorful output or JSON
- Copy all code to clipboard
- Automatically updates with new snippet changes
- Works on Linux, Mac and Windows
Installation
选择以下选项之一来安装命令行应用程序:
Option 1: NPM / Yarn
npm install -g 30s
yarn add -g 30s
Option 2: Source
$ git clone git@github.com:sQVe/30s.git
$ cd 30s/
$ npm install
$ node lib/index.js <command> <query>
Usage
Commands
Short version | Long version | Description |
---|---|---|
r | random | View random snippet |
s | search | Fuzzy search (RegExp) snippets by id |
t | tag | View snippets by tag |
v | view | View snippet with id |
* | View snippet with id |
Options
Short version | Long version | Description |
---|---|---|
-c | --cp | Copy snippet code to clipboard |
-j | --json | Print output in JSON format |
-l | --layout | Print output with specified layout (default: "itced") |
-h | --help | Output usage information |
Layout
Layout key | Description |
---|---|
i | Output snippet id |
t | Output snippet tags |
c | Output snippet code |
e | Output snippet examples |
d | Output snippet description |
Examples
Example | Description |
---|---|
30s head | View snippet with id head |
30s v head | View snippet with id head |
30s view head | View snippet with id head |
30s r | View random snippet |
30s random | View random snippet |
30s t array | View snippets by tag array |
30s tag array | View snippets by tag array |
30s s all | Find all snippets with an id that contains all |
30s search all | Find all snippets with an id that contains all |
30s view merge --cp | View snippet with id merge and copy its code |
30s view merge --json | View snippet with id merge and output as JSON |
30s search all --layout ce | Find all snippets with an id that contains all and output code and example |
Contributing
Bug reports & feature requests
请使用 issue tracker 报告错误或文件功能请求。
Developing
拉取请求非常受欢迎。 执行以下操作以开始提供帮助:
- Fork this repository to your own GitHub account and then clone it to your local device.
- Run
npm install
in the created directory to install all necessary dependencies.
可选步骤:
- Uninstall
30s
if it's already installed:npm uninstall -g 30s
- Link it to the global module directory:
npm link
Style guide & conventions
尝试遵循函数式编程最佳实践。 尽可能使用纯函数和 Ramda
。
编写提交如下:Angular Commit Message Conventions。 这使我们能够在 上与
和semantic-release
一起自动发布新版本修复feat
提交类型。
prettier
和 eslint-config-sqve
(基于 standardjs
的配置) 强制我们的样式和格式。 它会在 pre-commit
上自动运行,还会在 Travis CI 上检查问题。
Roadmap
有关详细的开发路线图,请参阅开发板。 以下是重要改进的简要概述:
- Autocomplete with
omelette
- Replace
commander
with basicyargs
and own logic
Thanks
非常感谢 30 的核心团队和所有贡献者-seconds-of-code
用于创建精选的精彩片段集合。
License
Creative Commons License
CC0 1.0 Universal
30s
A command-line application for 30 seconds of code
snippets.
Features
- Written in JavaScript (ES6)
- View, view by tag and search snippets
- Show what you find necessary by picking a layout
- Colorful output or JSON
- Copy all code to clipboard
- Automatically updates with new snippet changes
- Works on Linux, Mac and Windows
Installation
Pick one of the following options to install the command-line application:
Option 1: NPM / Yarn
npm install -g 30s
yarn add -g 30s
Option 2: Source
$ git clone git@github.com:sQVe/30s.git
$ cd 30s/
$ npm install
$ node lib/index.js <command> <query>
Usage
Commands
Short version | Long version | Description |
---|---|---|
r | random | View random snippet |
s | search | Fuzzy search (RegExp) snippets by id |
t | tag | View snippets by tag |
v | view | View snippet with id |
* | View snippet with id |
Options
Short version | Long version | Description |
---|---|---|
-c | --cp | Copy snippet code to clipboard |
-j | --json | Print output in JSON format |
-l | --layout | Print output with specified layout (default: "itced") |
-h | --help | Output usage information |
Layout
Layout key | Description |
---|---|
i | Output snippet id |
t | Output snippet tags |
c | Output snippet code |
e | Output snippet examples |
d | Output snippet description |
Examples
Example | Description |
---|---|
30s head | View snippet with id head |
30s v head | View snippet with id head |
30s view head | View snippet with id head |
30s r | View random snippet |
30s random | View random snippet |
30s t array | View snippets by tag array |
30s tag array | View snippets by tag array |
30s s all | Find all snippets with an id that contains all |
30s search all | Find all snippets with an id that contains all |
30s view merge --cp | View snippet with id merge and copy its code |
30s view merge --json | View snippet with id merge and output as JSON |
30s search all --layout ce | Find all snippets with an id that contains all and output code and example |
Contributing
Bug reports & feature requests
Please use the issue tracker to report bugs or file feature requests.
Developing
Pull requests are more than welcome. Do the following to start helping out:
- Fork this repository to your own GitHub account and then clone it to your local device.
- Run
npm install
in the created directory to install all necessary dependencies.
Optional steps:
- Uninstall
30s
if it's already installed:npm uninstall -g 30s
- Link it to the global module directory:
npm link
Style guide & conventions
Try to follow functional programming best practices. Use pure functions and Ramda
when possible.
Write commits following: Angular Commit Message Conventions. This enables us to automatically release new versions together with semantic-release
on fix
and feat
commit types.
prettier
and eslint-config-sqve
(a config based on standardjs
) enforces our styling and formatting. It runs automatically on pre-commit
and is also checked for issues on Travis CI.
Roadmap
See the development board for a detailed development roadmap. Below are a short outline of important improvements:
- Autocomplete with
omelette
- Replace
commander
with basicyargs
and own logic
Thanks
A big thank you to the core team and all the contributers at 30-seconds-of-code
for creating an awesome curated collection of snippets.
License
Creative Commons License
CC0 1.0 Universal