Cut the gists out of your code.
npm install resk> Resk helps you create gists from your source code.
> https://medium.com/@maticzav/resk-%EF%B8%8F-ac5d1f92be66
It's so simple! Add a start and end comment to the part of the code you would like to turn into a gist.
For example, if you had a TypeScript file, you could do something like this:
``ts
/ resk start "users" /
const users = {
matic: {
id: 1,
name: 'Matic',
role: 'admin',
},
}
/ resk end "users" /
/ resk start "libraries" /
const libraries = {
resk: {
cool: 9001,
},
}
/ resk end "libraries" /
`
This would create two gists - one named users and one named libraries. Besides that, it will also create a dump in .github/resk.json which includes pointers to your latest gists. This way, you don't have to change urls as you push changes.
Supported languages:
- Typescript/Javascript: / resk start ", / resk end "
- Yaml: , # resk end "
> Note: resk automatically ignores everything in /tests/, /dist/, and /node_modules/.
Example usage:
`yml
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: npx resk maticzav/resk
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
`
or
`bash`
npx resk
or
`yaml
on: [push]
jobs:
sync:
runs-on: ubuntu-latest
steps:
- name: Resk
uses: maticzav/resk@v2
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
`
> NOTE: You must provide the environment variable GH_TOKEN.
?Scissors make a "resk" when you cut the paper. Making gists is like cutting gists out of a big paper.
Please create a PR with the new features. To add a new language please add a language specification in the src/languages.ts file, create a sample file in tests/__fixtures__/ folder, and add documentation above. You might also need to update some snapshots. Use yarn test -u` to do that.
Thank you for contributing! :raised_hands:
MIT @ Zavadlal Matic