chore(release): 2.2.0 [skip ci]

# [2.2.0](https://github.com/simonecorsi/mawesome/compare/v2.1.0...v2.2.0) (2022-07-06)

### Bug Fixes

* compact by topic check ([49f6687](49f66875e3))
* compact by topic check ([01cfb39](01cfb39a41))
* docs ([4d7eef0](4d7eef0991))

### Features

* adds compacted by topics ([30fa351](30fa351b37))
* adds compacted by topics ([9dfa1f3](9dfa1f3dae))

.eslintrc

@@ -1,21 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 2020,
-    "sourceType": "module"
-  },
-  "env": {
-    "es6": true,
-    "node": true
-  },
-  "extends": [
-    "prettier/@typescript-eslint",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:prettier/recommended"
-  ],
-  "rules": {
-    "@typescript-eslint/no-var-requires": "off",
-    "prefer-rest-params": "off",
-    "@typescript-eslint/no-non-null-assertion": "off"
-  }
-}

.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  root: true,
+  parserOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module',
+  },
+  env: {
+    node: true,
+  },
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'plugin:prettier/recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+};

.github/CODEOWNERS

@@ -0,0 +1,13 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in the repo.
+*       @simonecorsi
+
+# Order is important. The last matching pattern has the most precedence.
+# So if a pull request only touches javascript files, only these owners
+# will be requested to review.
+# *.js    @octocat @github/js
+
+# You can also use email addresses if you prefer.
+# docs/*  docs@example.com

.github/dependabot.yml

@@ -0,0 +1,18 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: 'npm' # See documentation for possible values
+    directory: '/' # Location of package manifests
+    schedule:
+      interval: 'daily'
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+    open-pull-requests-limit: 10

.github/pull_request_template.md

@@ -0,0 +1,15 @@
+## 🚨 Proposed changes
+
+> Please review the [guidelines for contributing](../../CONTRIBUTING.md) to this repository.
+
+[[Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.]]
+
+## ⚙️ Types of changes
+
+What types of changes does your code introduce? _Put an `x` in the boxes that apply_
+
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation Update (if none of the other choices apply)
+- [ ] Refactor

.github/workflows/merge.yaml

@@ -1,19 +0,0 @@
-name: Test
-
-on: [pull_request]
-
-jobs:
-  version:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      - uses: actions/cache@v2
-        with:
-          path: '**/node_modules'
-          key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
-
-      - name: tests
-        run: npm cit

.github/workflows/release.yaml

@@ -1,47 +0,0 @@
-name: Publish workflow
-
-on:
-  push:
-    branches: main
-
-jobs:
-  version:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      - uses: fregante/setup-git-user@v1
-
-      - uses: actions/cache@v2
-        with:
-          path: '**/node_modules'
-          key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
-
-      - name: tests
-        run: npm cit
-
-      - name: build
-        run: npm run build
-
-      - name: Bump version and push tag
-        id: changelog
-        uses: TriPSs/conventional-changelog-action@v2
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          git-message: 'chore(release): {version}'
-          preset: ''
-
-      - name: Create github Release
-        uses: actions/create-release@v1
-        if: ${{ steps.changelog.outputs.skipped == 'false' }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ steps.changelog.outputs.tag }}
-          release_name: ${{ steps.changelog.outputs.tag }}
-          body: ${{ steps.changelog.outputs.changelog }}
-
-      - name: Latest tag
-        uses: EndBug/latest-tag@v1.4.0

.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: Release
+
+on: [workflow_dispatch]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+          persist-credentials: false
+
+      - name: Install dependencies
+        run: npm i
+
+      - name: Build
+        run: npm run build
+
+      - name: Semantic release
+        uses: codfish/semantic-release-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          GIT_AUTHOR_NAME: '${{ github.actor }}'
+          GIT_COMMITTER_NAME: '${{ github.actor }}'

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install lint-staged

.huskyrc.js

@@ -1,7 +0,0 @@
-module.exports = {
-  hooks: {
-    'prepare-commit-msg': 'exec < /dev/tty && git cz --hook || true',
-    'pre-commit': 'lint-staged',
-    'commit-msg': 'commitlint -E HUSKY_GIT_PARAMS',
-  },
-};

.releaserc.json

@@ -0,0 +1,30 @@
+{
+  "branches": [
+    { "name": "main" },
+    { "name": "next", "channel": "next", "prerelease": true }
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "index.js",
+          "CHANGELOG.md",
+          "package.json",
+          "package-lock.json"
+        ]
+      }
+    ],
+    "@semantic-release/github",
+    [
+      "@saithodev/semantic-release-backmerge",
+      {
+        "branches": [{ "from": "main", "to": "next" }],
+        "clearWorkspace": true
+      }
+    ]
+  ]
+}

CHANGELOG.md

@@ -1,35 +1,97 @@
+# [2.2.0](https://github.com/simonecorsi/mawesome/compare/v2.1.0...v2.2.0) (2022-07-06)
+
+
+### Bug Fixes
+
+* compact by topic check ([49f6687](https://github.com/simonecorsi/mawesome/commit/49f66875e34ef186f183e370979ef751694d08b2))
+* compact by topic check ([01cfb39](https://github.com/simonecorsi/mawesome/commit/01cfb39a41a2f60c709fd6dd6a46073149d96c20))
+* docs ([4d7eef0](https://github.com/simonecorsi/mawesome/commit/4d7eef0991d896027ac464a40edfc564ced6bdd2))
+
+
+### Features
+
+* adds compacted by topics ([30fa351](https://github.com/simonecorsi/mawesome/commit/30fa351b37a04357303f59c79a90f92219f8072c))
+* adds compacted by topics ([9dfa1f3](https://github.com/simonecorsi/mawesome/commit/9dfa1f3dae6c69033c682211c0e6bd9dc5a81eaf))
+
+# [2.1.0](https://github.com/simonecorsi/mawesome/compare/v2.0.0...v2.1.0) (2022-05-11)
+
+
+### Bug Fixes
+
+* removes console.log ([7841262](https://github.com/simonecorsi/mawesome/commit/7841262e741f05debb7ffe6fed636a508a8f7c12))
+
+
+### Features
+
+* removes github-token need ([0dc2a51](https://github.com/simonecorsi/mawesome/commit/0dc2a51ddf3cf93414afd674ed3c34ec681f3e4b))
+
+# [2.0.0](https://github.com/simonecorsi/mawesome/compare/v1.0.45...v2.0.0) (2022-05-11)
+
+
+### Bug Fixes
+
+* fixes default template path ([6cd9c30](https://github.com/simonecorsi/mawesome/commit/6cd9c30b20acb0789668b9fd4cdbace2cb52d3ce))
+* fixes tsc build ([ec10b79](https://github.com/simonecorsi/mawesome/commit/ec10b79a91bc5894d35b80026d3e216420e0721a))
+* normalize template file loadup ([445f562](https://github.com/simonecorsi/mawesome/commit/445f562fb50567d995f0d080d4267fc8d494731b))
+* pre-tags ([d1d4edd](https://github.com/simonecorsi/mawesome/commit/d1d4edd104affc69984905c8408e859c25c58443))
+* removes unused tests ([a141d23](https://github.com/simonecorsi/mawesome/commit/a141d23972c31b3dbd7e9841168219ad42fa7a18))
+* reworking files ([19c4c8f](https://github.com/simonecorsi/mawesome/commit/19c4c8f761b244ddccbc445cc34078bf932559d2))
+* updates gh-star-fetch ([3ec4b7c](https://github.com/simonecorsi/mawesome/commit/3ec4b7cd53c1fe885a51fb64279047a201d535dc))
+
+
+### Features
+
+* release major ([51a4359](https://github.com/simonecorsi/mawesome/commit/51a4359d983be4c842410f0c62104fca1b28252f))
+* update to node16 ([e1f37af](https://github.com/simonecorsi/mawesome/commit/e1f37af978ebcb7f770949476ac7d6bc788a1fc2))
+* updates deps ([7ade95d](https://github.com/simonecorsi/mawesome/commit/7ade95df8566a59145652165400cddfd1afa4bed))
+* using gh-star-fetch ([346ba5d](https://github.com/simonecorsi/mawesome/commit/346ba5d4b7ba6a71bab99f2dbe3c2d010beb67d5))
+* **template:** adds templates ([2c742b8](https://github.com/simonecorsi/mawesome/commit/2c742b820558fd715de987178303c460f5871c29)), closes [#14](https://github.com/simonecorsi/mawesome/issues/14)
+
+
+### BREAKING CHANGES
+
+* refactored code
+
+# [1.1.0-next.2](https://github.com/simonecorsi/mawesome/compare/v1.1.0-next.1...v1.1.0-next.2) (2022-05-09)
+
+
+### Features
+
+* using gh-star-fetch ([a8b6577](https://github.com/simonecorsi/mawesome/commit/a8b657735b9879636cc039d79fddcdca33ccf38e))
+
+# [1.1.0-next.1](https://github.com/simonecorsi/mawesome/compare/v1.0.45...v1.1.0-next.1) (2022-04-13)
+
+
+### Bug Fixes
+
+* pre-tags ([602befc](https://github.com/simonecorsi/mawesome/commit/602befcb5494b5bfd74d2333899311b81ea9da6d))
+
+
+### Features
+
+* **template:** adds templates ([791de9a](https://github.com/simonecorsi/mawesome/commit/791de9ab504de50e2e9cb031b9e373d7cc0589c0)), closes [#14](https://github.com/simonecorsi/mawesome/issues/14)
+
+## <small>1.0.45 (2022-01-17)</small>
+
+- build(deps): bump shelljs from 0.8.4 to 0.8.5 ([1da350a](https://github.com/simonecorsi/mawesome/commit/1da350a))
+
+## <small>1.0.44 (2021-10-26)</small>
+
+- chore(release): v1.0.44 ([6ffe17f](https://github.com/simonecorsi/mawesome/commit/6ffe17f))
+- feat: git add multiple files at once ([4aef61f](https://github.com/simonecorsi/mawesome/commit/4aef61f))
+
+## <small>1.0.43 (2021-10-15)</small>
+
+- chore(release): v1.0.43 ([5e0ef82](https://github.com/simonecorsi/mawesome/commit/5e0ef82))
+- feat: reduce json output size ([94635fe](https://github.com/simonecorsi/mawesome/commit/94635fe))
+
 ## <small>1.0.42 (2021-10-14)</small>
 
-* fix(paginator): last page now correctly matches rex ([dcf9898](https://github.com/simonecorsi/mawesome/commit/dcf9898))
+- chore(release): v1.0.42 ([5b36813](https://github.com/simonecorsi/mawesome/commit/5b36813))
-
+- fix(paginator): last page now correctly matches rex ([dcf9898](https://github.com/simonecorsi/mawesome/commit/dcf9898))
-
 
 ## <small>1.0.41 (2021-10-14)</small>
 
-* chore(release): v1.0.41 ([884fc90](https://github.com/simonecorsi/mawesome/commit/884fc90))
+- chore(release): v1.0.41 ([884fc90](https://github.com/simonecorsi/mawesome/commit/884fc90))
-* test: fixs suite ([b97833f](https://github.com/simonecorsi/mawesome/commit/b97833f))
+- test: fixs suite ([b97833f](https://github.com/simonecorsi/mawesome/commit/b97833f))
-* fix: should avoid index lock ([1d6848c](https://github.com/simonecorsi/mawesome/commit/1d6848c))
+- fix: should avoid index lock ([1d6848c](https://github.com/simonecorsi/mawesome/commit/1d6848c))
-
-
-
-## <small>1.0.40 (2021-10-13)</small>
-
-* chore(release): v1.0.40 ([0e016f4](https://github.com/simonecorsi/mawesome/commit/0e016f4))
-* fix: fixes while exit condition ([8f9b4cc](https://github.com/simonecorsi/mawesome/commit/8f9b4cc))
-* feat: paginates using async generator ([51da6c2](https://github.com/simonecorsi/mawesome/commit/51da6c2))
-
-
-
-## <small>1.0.39 (2021-08-31)</small>
-
-* chore(release): v1.0.39 ([f7a8341](https://github.com/simonecorsi/mawesome/commit/f7a8341))
-* build(deps): bump path-parse from 1.0.6 to 1.0.7 ([ef137b5](https://github.com/simonecorsi/mawesome/commit/ef137b5))
-
-
-
-## <small>1.0.38 (2021-06-23)</small>
-
-* chore(release): v1.0.38 ([3e66d85](https://github.com/simonecorsi/mawesome/commit/3e66d85))
-
-
-

README.md

@@ -8,11 +8,12 @@ You can see an example of the output at my own [simonecorsi/awesome](https://git
 
 <!-- toc -->
 
-- [Table of Contents](#table-of-contents)
 - [Documentation](#documentation)
   - [Requirements](#requirements)
   - [Configuration](#configuration)
     - [`api-token`](#api-token)
+    - [`compact-by-topic`](#compact-by-topic)
+    - [`template-path`](#template-path)
 - [Example workflow](#example-workflow)
 
 <!-- tocstop -->
@@ -21,32 +22,44 @@ You can see an example of the output at my own [simonecorsi/awesome](https://git
 
 ### Requirements
 
--   An empty repository
+- An empty repository
--   A personal github api key
+- A personal github api key
 
 ### Configuration
 
 The service can be configured setting the appropriate environment variables or writing an `.env` file.
 
-| Variable       | Description                                 | Default                          |
+| Variable           | Description                                                         | Default                          |
-| -------------- | ------------------------------------------- | -------------------------------- |
+| ------------------ | ------------------------------------------------------------------- | -------------------------------- |
-| `api-token`    | Personal github api token.                  | `${{ secrets.API_TOKEN }}`       |
+| `api-token`        | Personal Token is used to avoid rate limit, [read more](#api-token) | `${{ secrets.API_TOKEN }}`       |
-| `github-token` | Action Token                                | `${{ secrets.GITHUB_TOKEN }}`    |
+| `compact-by-topic` | Render another list in `TOPICS.md` compacted by github topics       | `'false'`                        |
-| `github-name`  | Name used for the commit, default to action | Github Action                    |
+| `github-name`      | Name used for the commit                                            | Github Action                    |
-| `github-email` | email used for commit, default to action    | actions@users.noreply.github.com |
+| `github-email`     | email used for commit                                               | actions@users.noreply.github.com |
+| `template-path`    | Custom `README.md` template, [read more](#template-path)            |
+| `output-filename`  | Output filename                                                     | `README.md`                      |
 
 #### `api-token`
 
 The Personal API Access Token is mandatory to fetch stars from the API without incurring in Rate Limits.
 
-You'll have to generate a [personal api token](https://github.com/settings/tokens/new) and then add 
+You'll have to generate a [personal api token](https://github.com/settings/tokens/new) and then add
+
+#### `compact-by-topic`
+
+If `compact-by-topic` is `'true'` it will generate another markdown file `TOPICS.md` whith all stars compacted by their github topics, be aware that this list will be bigger since data is duplicated.
+
+#### `template-path`
+
+If you don't like the output (default example [here](./TEMPLATE.ejs) ), you can provide your custom template that will be rendered using [EJS](https://ejs.co/) template engine.
+
+Path provided is relative to your current repository directory, if file is not found it will default.
 
 ## Example workflow
 
 ```yml
 name: Update awesome list
 
-on: 
+on:
   workflow_dispatch:
   schedule:
     - cron: '0 0 * * *'
@@ -63,5 +76,4 @@ jobs:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           github-email: ${{ secrets.USER_EMAIL }}
           github-name: ${{ github.repository_owner }}
-
 ```

TEMPLATE.ejs

@@ -1,4 +1,4 @@
-export default `# <%= username %> Awesome List [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
+# <%= username %> Awesome List [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
 
 > :star: generated with [simonecorsi/mawesome](https://github.com/simonecorsi/mawesome)
 
@@ -11,4 +11,3 @@ export default `# <%= username %> Awesome List [![Awesome](https://cdn.rawgit.co
 <% } %>  
 
 <% } %>
-`;

action.yml

@@ -4,16 +4,29 @@ branding:
   icon: align-justify
   color: yellow
 inputs:
-  github-token:
+  compact-by-topic:
-    description: 'Github token'
+    description: 'Generate another page with output compacted by github topics'
-    required: true
+    default: 'false'
+    required: false
   api-token:
     description: 'Personal API Token'
     required: true
   github-name:
     description: 'Name shown in the commit'
+    default: 'GitHub Actions'
+    required: false
   github-email:
     description: 'Email shown in the commit'
+    default: 'actions@users.noreply.github.com'
+    required: false
+  template-path:
+    required: false
+    description: 'EJS template path relative to project root directory'
+    default: 'TEMPLATE.ejs'
+  output-filename:
+    description: 'The output file name, default to README.md'
+    required: false
+    default: 'README.md'
 runs:
-  using: 'node12'
+  using: 'node16'
   main: 'index.js'

ava.config.js

@@ -1,7 +0,0 @@
-/* eslint-disable node/no-unsupported-features/es-syntax */
-
-export default {
-  files: ['!templates/**/*'],
-  extensions: ['ts'],
-  require: ['ts-node/register/transpile-only'],
-};

package.json

@@ -1,18 +1,16 @@
 {
   "name": "mawesome",
-  "version": "1.0.42",
+  "version": "2.0.0-0",
   "description": "Generate awesome list from user starred repositories",
   "main": "index.js",
   "author": "Simone Corsi<simonecorsi.dev@gmail.com>",
   "license": "MIT",
   "scripts": {
-    "test": "nyc --reporter=lcov --reporter=text-summary ava -s -v",
-    "test:watch": "ava -w",
     "style:lint": "eslint src --ext .ts",
     "style:prettier": "prettier \"src/**/*.ts\" --list-different --write",
     "build": "./node_modules/.bin/ncc build src/index.ts -o ./",
     "dev": "ts-node-dev src/index.ts",
-    "prerelease": "npm run build"
+    "prepare": "node prepare.js || echo 'Skipping prepare'"
   },
   "keywords": [
     "github",
@@ -24,43 +22,47 @@
     "javascript"
   ],
   "devDependencies": {
-    "@commitlint/cli": "^11.0.0",
+    "@commitlint/cli": "^17.0.3",
-    "@commitlint/config-conventional": "^11.0.0",
+    "@commitlint/config-conventional": "^17.0.3",
-    "@octokit/rest": "^18.0.12",
+    "@octokit/rest": "^18.12.0",
-    "@octokit/types": "^6.2.1",
+    "@octokit/types": "^6.39.0",
-    "@types/ejs": "^3.0.5",
+    "@saithodev/semantic-release-backmerge": "^2.1.2",
-    "@types/got": "^9.6.11",
+    "@semantic-release/changelog": "^6.0.1",
-    "@types/node": "^14.14.5",
+    "@semantic-release/commit-analyzer": "^9.0.2",
-    "@types/sinon": "^9.0.10",
+    "@semantic-release/git": "^10.0.1",
-    "@typescript-eslint/eslint-plugin": "^4.6.0",
+    "@semantic-release/github": "^8.0.4",
-    "@typescript-eslint/parser": "^4.6.0",
+    "@semantic-release/release-notes-generator": "^10.0.3",
-    "@vercel/ncc": "^0.26.2",
+    "@types/ejs": "^3.1.1",
-    "ava": "^3.8.2",
+    "@types/got": "^9.6.12",
-    "benchmark": "^2.1.4",
+    "@types/node": "^18.0.3",
-    "cz-conventional-changelog": "^3.2.0",
+    "@types/sinon": "^10.0.12",
-    "eslint": "^7.17.0",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
-    "eslint-config-prettier": "^7.1.0",
+    "@typescript-eslint/parser": "^5.30.5",
+    "@vercel/ncc": "^0.34.0",
+    "eslint": "^8.19.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^4.2.5",
+    "husky": "^8.0.1",
-    "lint-staged": "^10.2.2",
+    "lint-staged": "^13.0.3",
     "markdown-toc": "^1.2.0",
     "nyc": "^15.0.1",
-    "prettier": "^2.0.5",
+    "prettier": "^2.7.1",
-    "sinon": "^9.2.3",
+    "sinon": "^14.0.0",
-    "standard-version": "^9.0.0",
+    "ts-node-dev": "^2.0.0",
-    "ts-node-dev": "^1.1.1",
+    "typescript": "^4.7.4"
-    "typescript": "^4.1.3"
   },
   "dependencies": {
-    "@actions/exec": "^1.0.4",
+    "@actions/core": "^1.9.0",
-    "@actions/core": "^1.2.6",
+    "@actions/exec": "^1.1.1",
-    "ejs": "^3.1.5",
+    "ejs": "^3.1.8",
+    "gh-star-fetch": "^1.5.0",
     "got": "^11.8.1",
-    "remark": "^13.0.0",
+    "remark": "^14.0.2",
-    "remark-toc": "^7.0.0"
+    "remark-toc": "^8.0.1"
   },
   "volta": {
-    "node": "14.15.4"
+    "node": "16.14.2",
+    "npm": "8.6.0"
   }
-}
+}

prepare.js

@@ -0,0 +1,13 @@
+'use strict';
+
+let isCi = false;
+
+try {
+  isCi = require('is-ci');
+} catch (_) {
+  isCi = true;
+}
+
+if (!isCi) {
+  require('husky').install();
+}

src/api.ts

@@ -1,11 +0,0 @@
-import got from 'got';
-import * as core from '@actions/core';
-
-const GITHUB_TOKEN = core.getInput('api-token', { required: true });
-
-export default got.extend({
-  headers: {
-    Authorization: `token ${GITHUB_TOKEN}`,
-  },
-  responseType: 'json',
-});

src/git.ts

@@ -2,13 +2,20 @@
 
 import * as core from '@actions/core';
 import * as exec from '@actions/exec';
+import fs from 'fs/promises';
 
 const { GITHUB_REPOSITORY, GITHUB_REF } = process.env;
 
 const branch = GITHUB_REF?.replace('refs/heads/', '');
+
+type File = {
+  filename: string;
+  data: string;
+};
+
 class Git {
   constructor() {
-    const githubToken = core.getInput('github-token', { required: true });
+    const githubToken = core.getInput('api-token', { required: true });
     core.setSecret(githubToken);
 
     const githubName = core.getInput('github-name') || 'GitHub Actions';
@@ -34,33 +41,39 @@ class Git {
     return isShallow.trim().replace('\n', '') === 'true';
   };
 
-  exec = (command: string): Promise<string> => {
+  async exec(command: string): Promise<string> {
-    return new Promise(async (resolve, reject) => {
+    let execOutput = '';
-      let execOutput = '';
 
-      const options = {
+    const options = {
-        listeners: {
+      listeners: {
-          stdout: (data: Buffer) => {
+        stdout: (data: Buffer) => {
-            execOutput += data.toString();
+          execOutput += data.toString();
-          },
         },
-      };
+      },
+    };
 
-      const exitCode = await exec.exec(`git ${command}`, undefined, options);
+    const exitCode = await exec.exec(`git ${command}`, undefined, options);
 
-      if (exitCode === 0) {
+    if (exitCode === 0) {
-        return resolve(execOutput);
+      return execOutput;
-      } else {
+    } else {
-        core.error(`Command "git ${command}" exited with code ${exitCode}.`);
+      core.error(`Command "git ${command}" exited with code ${exitCode}.`);
-        return reject(`Command "git ${command}" exited with code ${exitCode}.`);
+      throw new Error(`Command "git ${command}" exited with code ${exitCode}.`);
-      }
+    }
-    });
+  }
-  };
 
   config = (prop: string, value: string) =>
     this.exec(`config ${prop} "${value}"`);
 
-  add = (file: string) => this.exec(`add ${file}`);
+  add = (file: string | string[]) => {
+    let str = '';
+    if (Array.isArray(file)) {
+      file.map((f) => (str += ` ${f}`));
+    } else {
+      str = file;
+    }
+    return this.exec(`add ${str}`);
+  };
 
   commit = (message: string) => this.exec(`commit -m "${message}"`);
 
@@ -83,6 +96,20 @@ class Git {
   updateOrigin = (repo: string) => this.exec(`remote set-url origin ${repo}`);
 
   createTag = (tag: string) => this.exec(`tag -a ${tag} -m "${tag}"`);
+
+  async pushNewFiles(files: File[] = []): Promise<any> {
+    if (!files.length) return;
+
+    await this.pull();
+
+    await Promise.all(
+      files.map(({ filename, data }) => fs.writeFile(filename, data))
+    );
+
+    await this.add(files.map(({ filename }) => filename));
+    await this.commit(`chore(updates): updated entries in files`);
+    await this.push();
+  }
 }
 
 export default new Git();

src/helpers.ts

@@ -1,28 +1,14 @@
-import fs from 'fs';
 import ejs from 'ejs';
 import * as core from '@actions/core';
-import remark from 'remark';
+import { remark } from 'remark';
 import toc from 'remark-toc';
 
-import MD_TEMPLATE from './template';
-import GithubApi from './api';
-import link from './link';
-import git from './git';
-
-import type { PaginationLink, ApiGetStarResponse, Stars } from './types';
-
 export const REPO_USERNAME = process.env.GITHUB_REPOSITORY?.split('/')[0];
 export const API_STARRED_URL = `${process.env.GITHUB_API_URL}/users/${REPO_USERNAME}/starred`;
 
-const fsp = fs.promises;
-
-export function wait(time = 200): Promise<void> {
-  return new Promise((resolve) => setTimeout(resolve, time));
-}
-
 export async function renderer(
   data: { [key: string]: any },
-  templateString = MD_TEMPLATE
+  templateString: string
 ): Promise<string> {
   try {
     return ejs.render(templateString, data);
@@ -32,46 +18,6 @@ export async function renderer(
   }
 }
 
-export function getNextPage(links: PaginationLink[]): string | null {
-  const next = links.find((l) => l.rel === 'next');
-  const last = links.find((l) => l.rel === 'last');
-  if (!next || !last) return null;
-  const matchNext = next.uri.match(/page=([0-9]*)/);
-  const matchLast = last.uri.match(/page=([0-9]*)/);
-  if (!matchNext || !matchLast) return null;
-  if (matchNext[1] === matchLast[1]) return null;
-  return matchNext[1];
-}
-
-async function* paginateStars(url: string): AsyncGenerator<Stars> {
-  let nextPage: string | null = '1';
-  while (nextPage) {
-    try {
-      const { headers, body } = await GithubApi.get(url, {
-        searchParams: {
-          page: nextPage,
-        },
-      });
-      yield (body as unknown) as Stars;
-      nextPage = getNextPage(link.parse(headers.link).refs);
-      await wait(1000); // avoid limits
-    } catch (e) {
-      console.error(e);
-      break;
-    }
-  }
-}
-
-export async function apiGetStar(
-  url: string = API_STARRED_URL
-): Promise<ApiGetStarResponse> {
-  let data: Stars[] = [];
-  for await (const stars of paginateStars(url)) {
-    data = data.concat(stars);
-  }
-  return (data as unknown) as Stars;
-}
-
 export function generateMd(data: string): Promise<string> {
   return new Promise((resolve) => {
     remark()
@@ -87,26 +33,4 @@ export function generateMd(data: string): Promise<string> {
   });
 }
 
-export const MARKDOWN_FILENAME: string =
+export const MARKDOWN_FILENAME: string = core.getInput('output-filename');
-  core.getInput('output-filename') || 'README.md';
-
-type File = {
-  filename: string;
-  data: string;
-};
-
-export async function pushNewFiles(files: File[] = []): Promise<any> {
-  if (!files.length) return;
-
-  await git.pull();
-
-  await Promise.all(
-    files.map(async ({ filename, data }) => {
-      await fsp.writeFile(filename, data);
-      await git.add(filename);
-    })
-  );
-
-  await git.commit(`chore(updates): updated entries in files`);
-  await git.push();
-}

src/index.ts

@@ -1,53 +1,85 @@
+import path from 'path';
 import * as core from '@actions/core';
+import { readFile } from 'fs/promises';
+import ghStarFetch, {
+  Options,
+  compactByLanguage,
+  compactByTopic,
+} from 'gh-star-fetch';
 
 import {
   renderer,
   REPO_USERNAME,
   generateMd,
-  pushNewFiles,
   MARKDOWN_FILENAME,
-  apiGetStar,
 } from './helpers';
+import git from './git';
 
-import type { SortedLanguageList, Stars, Star } from './types';
+export async function main() {
-
+  // set default template
-export async function main(): Promise<any> {
+  let template = await readFile(
-  const results: Stars = await apiGetStar();
+    path.resolve(__dirname, './TEMPLATE.ejs'),
-
+    'utf8'
-  const sortedByLanguages = results.reduce(
-    (acc: SortedLanguageList, val: Star) => {
-      const language = val.language || 'generic';
-      if (!acc[language]) {
-        acc[language] = [val];
-      } else {
-        acc[language].push(val);
-      }
-      return acc;
-    },
-    {}
   );
 
-  const rendered = await renderer({
+  // get template if found in the repo
-    username: REPO_USERNAME,
+  const customTemplatePath = core.getInput('template-path');
-    stars: Object.entries(sortedByLanguages),
+  core.info(`check if customTemplatePath: ${customTemplatePath} exists`);
-    updatedAt: Date.now(),
+  try {
-  });
+    template = await readFile(customTemplatePath, 'utf8');
+  } catch {
+    core.info("Couldn't find template file, using default");
+  }
 
-  const markdown: string = await generateMd(rendered);
+  const opts: Partial<Options> = {
+    accessToken: core.getInput('api-token', { required: true }),
+  };
 
-  await pushNewFiles([
+  const results = await ghStarFetch(opts);
+
+  const files = [];
+
+  const compactedByLanguage = compactByLanguage(results);
+  const byLanguage = await renderer(
+    {
+      username: REPO_USERNAME,
+      stars: Object.entries(compactedByLanguage),
+      updatedAt: Date.now(),
+    },
+    template
+  );
+
+  files.push(
     {
       filename: MARKDOWN_FILENAME,
-      data: markdown,
+      data: await generateMd(byLanguage),
     },
     {
       filename: 'data.json',
-      data: JSON.stringify(sortedByLanguages, null, 2),
+      data: JSON.stringify(compactedByLanguage, null, 2),
-    },
+    }
-  ]);
+  );
+
+  if (core.getInput('compact-by-topic') === 'true') {
+    const compactedByTopic = compactByTopic(results);
+    const byTopic = await renderer(
+      {
+        username: REPO_USERNAME,
+        stars: Object.entries(compactedByTopic),
+        updatedAt: Date.now(),
+      },
+      template
+    );
+    files.push({
+      filename: 'TOPICS.md',
+      data: await generateMd(byTopic),
+    });
+  }
+
+  await git.pushNewFiles(files);
 }
 
-export async function run(): Promise<any> {
+export async function run(): Promise<void> {
   try {
     await main();
   } catch (error) {
@@ -57,8 +89,9 @@ export async function run(): Promise<any> {
 
 const catchAll = (info: any) => {
   core.setFailed(`#catchAll: ${info}`);
+  core.error(info);
 };
 process.on('unhandledRejection', catchAll);
 process.on('uncaughtException', catchAll);
 
-run();
+run().catch(core.error);

src/link.js

@@ -1,384 +0,0 @@
-/**
- * Copyright (c) 2016 Jonas Hermsmeier
- * https://github.com/jhermsmeier/node-http-link-header
- */
-
-/* istanbul ignore file */
-'use strict';
-
-var COMPATIBLE_ENCODING_PATTERN = /^utf-?8|ascii|utf-?16-?le|ucs-?2|base-?64|latin-?1$/i;
-var WS_TRIM_PATTERN = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;
-var WS_CHAR_PATTERN = /\s|\uFEFF|\xA0/;
-var WS_FOLD_PATTERN = /\r?\n[\x20\x09]+/g;
-var DELIMITER_PATTERN = /[;,"]/;
-var WS_DELIMITER_PATTERN = /[;,"]|\s/;
-
-/**
- * Token character pattern
- * @type {RegExp}
- * @see https://tools.ietf.org/html/rfc7230#section-3.2.6
- */
-var TOKEN_PATTERN = /^[!#$%&'*+\-\.^_`|~\da-zA-Z]+$/;
-
-var STATE = {
-  IDLE: 1 << 0,
-  URI: 1 << 1,
-  ATTR: 1 << 2,
-};
-
-function trim(value) {
-  return value.replace(WS_TRIM_PATTERN, '');
-}
-
-function hasWhitespace(value) {
-  return WS_CHAR_PATTERN.test(value);
-}
-
-function skipWhitespace(value, offset) {
-  while (hasWhitespace(value[offset])) {
-    offset++;
-  }
-  return offset;
-}
-
-function needsQuotes(value) {
-  return WS_DELIMITER_PATTERN.test(value) || !TOKEN_PATTERN.test(value);
-}
-
-class Link {
-  /**
-   * Link
-   * @constructor
-   * @param {String} [value]
-   * @returns {Link}
-   */
-  constructor(value) {
-    /** @type {Array} URI references */
-    this.refs = [];
-
-    if (value) {
-      this.parse(value);
-    }
-  }
-
-  /**
-   * Get refs with given relation type
-   * @param {String} value
-   * @returns {Array<Object>}
-   */
-  rel(value) {
-    var links = [];
-    var type = value.toLowerCase();
-
-    for (var i = 0; i < this.refs.length; i++) {
-      if (this.refs[i].rel.toLowerCase() === type) {
-        links.push(this.refs[i]);
-      }
-    }
-
-    return links;
-  }
-
-  /**
-   * Get refs where given attribute has a given value
-   * @param {String} attr
-   * @param {String} value
-   * @returns {Array<Object>}
-   */
-  get(attr, value) {
-    attr = attr.toLowerCase();
-
-    var links = [];
-
-    for (var i = 0; i < this.refs.length; i++) {
-      if (this.refs[i][attr] === value) {
-        links.push(this.refs[i]);
-      }
-    }
-
-    return links;
-  }
-
-  set(link) {
-    this.refs.push(link);
-    return this;
-  }
-
-  has(attr, value) {
-    attr = attr.toLowerCase();
-
-    for (var i = 0; i < this.refs.length; i++) {
-      if (this.refs[i][attr] === value) {
-        return true;
-      }
-    }
-
-    return false;
-  }
-
-  parse(value, offset) {
-    offset = offset || 0;
-    value = offset ? value.slice(offset) : value;
-
-    // Trim & unfold folded lines
-    value = trim(value).replace(WS_FOLD_PATTERN, '');
-
-    var state = STATE.IDLE;
-    var length = value.length;
-    var offset = 0;
-    var ref = null;
-
-    while (offset < length) {
-      if (state === STATE.IDLE) {
-        if (hasWhitespace(value[offset])) {
-          offset++;
-          continue;
-        } else if (value[offset] === '<') {
-          if (ref != null) {
-            ref.rel != null
-              ? this.refs.push(...Link.expandRelations(ref))
-              : this.refs.push(ref);
-          }
-          var end = value.indexOf('>', offset);
-          if (end === -1)
-            throw new Error(
-              'Expected end of URI delimiter at offset ' + offset
-            );
-          ref = { uri: value.slice(offset + 1, end) };
-          // this.refs.push( ref )
-          offset = end;
-          state = STATE.URI;
-        } else {
-          throw new Error(
-            'Unexpected character "' + value[offset] + '" at offset ' + offset
-          );
-        }
-        offset++;
-      } else if (state === STATE.URI) {
-        if (hasWhitespace(value[offset])) {
-          offset++;
-          continue;
-        } else if (value[offset] === ';') {
-          state = STATE.ATTR;
-          offset++;
-        } else if (value[offset] === ',') {
-          state = STATE.IDLE;
-          offset++;
-        } else {
-          throw new Error(
-            'Unexpected character "' + value[offset] + '" at offset ' + offset
-          );
-        }
-      } else if (state === STATE.ATTR) {
-        if (value[offset] === ';' || hasWhitespace(value[offset])) {
-          offset++;
-          continue;
-        }
-        var end = value.indexOf('=', offset);
-        if (end === -1)
-          throw new Error('Expected attribute delimiter at offset ' + offset);
-        var attr = trim(value.slice(offset, end)).toLowerCase();
-        var attrValue = '';
-        offset = end + 1;
-        offset = skipWhitespace(value, offset);
-        if (value[offset] === '"') {
-          offset++;
-          while (offset < length) {
-            if (value[offset] === '"') {
-              offset++;
-              break;
-            }
-            if (value[offset] === '\\') {
-              offset++;
-            }
-            attrValue += value[offset];
-            offset++;
-          }
-        } else {
-          var end = offset + 1;
-          while (!DELIMITER_PATTERN.test(value[end]) && end < length) {
-            end++;
-          }
-          attrValue = value.slice(offset, end);
-          offset = end;
-        }
-        if (ref[attr] && Link.isSingleOccurenceAttr(attr)) {
-          // Ignore multiples of attributes which may only appear once
-        } else if (attr[attr.length - 1] === '*') {
-          ref[attr] = Link.parseExtendedValue(attrValue);
-        } else {
-          attrValue = attr === 'type' ? attrValue.toLowerCase() : attrValue;
-          if (ref[attr] != null) {
-            if (Array.isArray(ref[attr])) {
-              ref[attr].push(attrValue);
-            } else {
-              ref[attr] = [ref[attr], attrValue];
-            }
-          } else {
-            ref[attr] = attrValue;
-          }
-        }
-        switch (value[offset]) {
-          case ',':
-            state = STATE.IDLE;
-            break;
-          case ';':
-            state = STATE.ATTR;
-            break;
-        }
-        offset++;
-      } else {
-        throw new Error('Unknown parser state "' + state + '"');
-      }
-    }
-
-    if (ref != null) {
-      ref.rel != null
-        ? this.refs.push(...Link.expandRelations(ref))
-        : this.refs.push(ref);
-    }
-
-    ref = null;
-
-    return this;
-  }
-
-  toString() {
-    var refs = [];
-    var link = '';
-    var ref = null;
-
-    for (var i = 0; i < this.refs.length; i++) {
-      ref = this.refs[i];
-      link = Object.keys(this.refs[i]).reduce(function (link, attr) {
-        if (attr === 'uri') return link;
-        return link + '; ' + Link.formatAttribute(attr, ref[attr]);
-      }, '<' + ref.uri + '>');
-      refs.push(link);
-    }
-
-    return refs.join(', ');
-  }
-}
-
-/**
- * Determines whether an encoding can be
- * natively handled with a `Buffer`
- * @param {String} value
- * @returns {Boolean}
- */
-Link.isCompatibleEncoding = function (value) {
-  return COMPATIBLE_ENCODING_PATTERN.test(value);
-};
-
-Link.parse = function (value, offset) {
-  return new Link().parse(value, offset);
-};
-
-Link.isSingleOccurenceAttr = function (attr) {
-  return (
-    attr === 'rel' ||
-    attr === 'type' ||
-    attr === 'media' ||
-    attr === 'title' ||
-    attr === 'title*'
-  );
-};
-
-Link.isTokenAttr = function (attr) {
-  return attr === 'rel' || attr === 'type' || attr === 'anchor';
-};
-
-Link.escapeQuotes = function (value) {
-  return value.replace(/"/g, '\\"');
-};
-
-Link.expandRelations = function (ref) {
-  var rels = ref.rel.split(' ');
-  return rels.map(function (rel) {
-    var value = Object.assign({}, ref);
-    value.rel = rel;
-    return value;
-  });
-};
-
-/**
- * Parses an extended value and attempts to decode it
- * @internal
- * @param {String} value
- * @return {Object}
- */
-Link.parseExtendedValue = function (value) {
-  var parts = /([^']+)?(?:'([^']+)')?(.+)/.exec(value);
-  return {
-    language: parts[2].toLowerCase(),
-    encoding: Link.isCompatibleEncoding(parts[1])
-      ? null
-      : parts[1].toLowerCase(),
-    value: Link.isCompatibleEncoding(parts[1])
-      ? decodeURIComponent(parts[3])
-      : parts[3],
-  };
-};
-
-/**
- * Format a given extended attribute and it's value
- * @param {String} attr
- * @param {Object} data
- * @return {String}
- */
-Link.formatExtendedAttribute = function (attr, data) {
-  var encoding = (data.encoding || 'utf-8').toUpperCase();
-  var language = data.language || 'en';
-
-  var encodedValue = '';
-
-  if (Buffer.isBuffer(data.value) && Link.isCompatibleEncoding(encoding)) {
-    encodedValue = data.value.toString(encoding);
-  } else if (Buffer.isBuffer(data.value)) {
-    encodedValue = data.value.toString('hex').replace(/[0-9a-f]{2}/gi, '%$1');
-  } else {
-    encodedValue = encodeURIComponent(data.value);
-  }
-
-  return attr + '=' + encoding + "'" + language + "'" + encodedValue;
-};
-
-/**
- * Format a given attribute and it's value
- * @param {String} attr
- * @param {String|Object} value
- * @return {String}
- */
-Link.formatAttribute = function (attr, value) {
-  if (Array.isArray(value)) {
-    return value
-      .map((item) => {
-        return Link.formatAttribute(attr, item);
-      })
-      .join('; ');
-  }
-
-  if (attr[attr.length - 1] === '*' || typeof value !== 'string') {
-    return Link.formatExtendedAttribute(attr, value);
-  }
-
-  if (Link.isTokenAttr(attr)) {
-    value = needsQuotes(value)
-      ? '"' + Link.escapeQuotes(value) + '"'
-      : Link.escapeQuotes(value);
-  } else if (needsQuotes(value)) {
-    value = encodeURIComponent(value);
-    // We don't need to escape <SP> <,> <;> within quotes
-    value = value
-      .replace(/%20/g, ' ')
-      .replace(/%2C/g, ',')
-      .replace(/%3B/g, ';');
-
-    value = '"' + value + '"';
-  }
-
-  return attr + '=' + value;
-};
-
-module.exports = Link;

test/helpers.spec.ts

@@ -1,79 +0,0 @@
-import test from 'ava';
-import * as sinon from 'sinon';
-import fs from 'fs';
-
-import * as core from '@actions/core';
-sinon.replace(core, 'getInput', sinon.fake());
-
-import GithubApi from '../src/api';
-const GithubApiFake = sinon.fake((rul) => ({
-  body: [],
-  headers: {
-    link:
-      '<https://api.github.com/user/5617452/starred?page=2>; rel="next", <https://api.github.com/user/5617452/starred?page=2>; rel="last"',
-  },
-}));
-sinon.replace(GithubApi, 'get', GithubApiFake);
-
-import Git from '../src/git';
-const pull = sinon.fake();
-sinon.replace(Git, 'pull', pull);
-const add = sinon.fake();
-sinon.replace(Git, 'add', add);
-const commit = sinon.fake();
-sinon.replace(Git, 'commit', commit);
-const push = sinon.fake();
-sinon.replace(Git, 'push', push);
-sinon.replace(Git, 'config', sinon.fake());
-sinon.replace(Git, 'updateOrigin', sinon.fake());
-
-const fsp = fs.promises;
-const writeFile = sinon.fake();
-sinon.replace(fsp, 'writeFile', writeFile);
-
-import {
-  wait,
-  renderer,
-  apiGetStar,
-  generateMd,
-  pushNewFiles,
-} from '../src/helpers';
-
-test('wait should wait', async (t) => {
-  await wait(200);
-  t.pass();
-});
-
-test('renderer should render', async (t) => {
-  const output = await renderer({ variable: 123 }, 'Test: <%= variable %>');
-  t.is(output, 'Test: 123');
-});
-
-test('apiGetStar', async (t) => {
-  let stars = await apiGetStar('url');
-  t.true(GithubApiFake.called);
-  t.true(Array.isArray(stars));
-});
-
-test('generateMd should create TOC', async (t) => {
-  const tpl = `# title
-
-## Table of Contents
-
-## Javascript
-`;
-  const result = await generateMd(tpl);
-  t.is(
-    result,
-    `# title\n\n## Table of Contents\n\n*   [Javascript](#javascript)\n\n## Javascript\n`
-  );
-});
-
-test('should push', async (t) => {
-  await pushNewFiles([{ filename: 'README.md', data: '# title' }]);
-  t.true(writeFile.called);
-  t.true(pull.called);
-  t.true(add.called);
-  t.true(commit.called);
-  t.true(push.called);
-});