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))

.github/workflows/merge.yml

@@ -1,21 +0,0 @@
-name: Run tests
-
-on: [pull_request]
-
-jobs:
-  test:
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        node-version: [16.x]
-
-    runs-on: ${{ matrix.os }}
-
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: npm it

.github/workflows/release.yml

@@ -3,26 +3,7 @@ name: Release
 on: [workflow_dispatch]
 
 jobs:
-  test:
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        node-version: [16.x]
-
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Install dependencies
-        run: npm it
-
   release:
-    needs: [test]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/setup-node@v3
@@ -30,7 +11,8 @@ jobs:
           node-version: 16
       - uses: actions/checkout@v3
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.GH_TOKEN }}
+          persist-credentials: false
 
       - name: Install dependencies
         run: npm i
@@ -41,6 +23,6 @@ jobs:
       - name: Semantic release
         uses: codfish/semantic-release-action@v1
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           GIT_AUTHOR_NAME: '${{ github.actor }}'
           GIT_COMMITTER_NAME: '${{ github.actor }}'

.releaserc.json

@@ -10,7 +10,12 @@
     [
       "@semantic-release/git",
       {
-        "assets": ["CHANGELOG.md", "package.json", "package-lock.json"]
+        "assets": [
+          "index.js",
+          "CHANGELOG.md",
+          "package.json",
+          "package-lock.json"
+        ]
       }
     ],
     "@semantic-release/github",
@@ -18,7 +23,7 @@
       "@saithodev/semantic-release-backmerge",
       {
         "branches": [{ "from": "main", "to": "next" }],
-        "backmergeStrategy": "rebase"
+        "clearWorkspace": true
       }
     ]
   ]

CHANGELOG.md

@@ -1,3 +1,57 @@
+# [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)
 
 

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,9 +4,10 @@ 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
@@ -27,5 +28,5 @@ inputs:
     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,15 @@
 {
   "name": "mawesome",
-  "version": "1.1.0-next.1",
+  "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": [
@@ -25,45 +22,44 @@
     "javascript"
   ],
   "devDependencies": {
-    "@commitlint/cli": "^16.2.3",
+    "@commitlint/cli": "^17.0.3",
-    "@commitlint/config-conventional": "^16.2.1",
+    "@commitlint/config-conventional": "^17.0.3",
     "@octokit/rest": "^18.12.0",
-    "@octokit/types": "^6.2.1",
+    "@octokit/types": "^6.39.0",
     "@saithodev/semantic-release-backmerge": "^2.1.2",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/commit-analyzer": "^9.0.2",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^8.0.4",
     "@semantic-release/release-notes-generator": "^10.0.3",
-    "@types/ejs": "^3.0.5",
+    "@types/ejs": "^3.1.1",
     "@types/got": "^9.6.12",
-    "@types/node": "^14.14.5",
+    "@types/node": "^18.0.3",
-    "@types/sinon": "^9.0.10",
+    "@types/sinon": "^10.0.12",
-    "@typescript-eslint/eslint-plugin": "^5.22.0",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
-    "@typescript-eslint/parser": "^5.22.0",
+    "@typescript-eslint/parser": "^5.30.5",
-    "@vercel/ncc": "^0.33.3",
+    "@vercel/ncc": "^0.34.0",
-    "ava": "^3.8.2",
+    "eslint": "^8.19.0",
-    "eslint": "^7.17.0",
+    "eslint-config-prettier": "^8.5.0",
-    "eslint-config-prettier": "^7.1.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^7.0.4",
+    "husky": "^8.0.1",
-    "lint-staged": "^12.3.7",
+    "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",
-    "ts-node-dev": "^1.1.1",
+    "ts-node-dev": "^2.0.0",
-    "typescript": "^4.6.4"
+    "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@actions/core": "^1.2.6",
+    "@actions/core": "^1.9.0",
     "@actions/exec": "^1.1.1",
-    "ejs": "^3.1.6",
+    "ejs": "^3.1.8",
-    "gh-star-fetch": "^1.1.0",
+    "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": "16.14.2",

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';
@@ -89,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,17 +1,11 @@
-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 git from './git';
-
-import type { PaginationLink, ApiGetStarResponse, Stars, Star } 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 async function renderer(
   data: { [key: string]: any },
   templateString: string
@@ -40,22 +34,3 @@ export function generateMd(data: string): Promise<string> {
 }
 
 export const MARKDOWN_FILENAME: string = core.getInput('output-filename');
-
-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(({ filename, data }) => fsp.writeFile(filename, data))
-  );
-
-  await git.add(files.map(({ filename }) => filename));
-  await git.commit(`chore(updates): updated entries in files`);
-  await git.push();
-}

src/index.ts

@@ -1,60 +1,85 @@
+import path from 'path';
 import * as core from '@actions/core';
-import { readdir, readFile } from 'fs/promises';
+import { readFile } from 'fs/promises';
-import ghStarFetch from 'gh-star-fetch';
+import ghStarFetch, {
+  Options,
+  compactByLanguage,
+  compactByTopic,
+} from 'gh-star-fetch';
 
 import {
   renderer,
   REPO_USERNAME,
   generateMd,
-  pushNewFiles,
   MARKDOWN_FILENAME,
 } from './helpers';
-import MD_TEMPLATE from './template';
+import git from './git';
 
 export async function main() {
   // set default template
-  let template = MD_TEMPLATE;
+  let template = await readFile(
+    path.resolve(__dirname, './TEMPLATE.ejs'),
+    'utf8'
+  );
 
   // get template if found in the repo
   const customTemplatePath = core.getInput('template-path');
-  console.log(`check if customTemplatePath: ${customTemplatePath} exists`);
+  core.info(`check if customTemplatePath: ${customTemplatePath} exists`);
   try {
-    const dir = await readdir('./');
+    template = await readFile(customTemplatePath, 'utf8');
-    console.log(dir.join('\n'));
-    template = await readFile('TEMPLATE.ejs', 'utf8');
   } catch {
-    console.log("Couldn't find template file, using default");
+    core.info("Couldn't find template file, using default");
   }
 
-  const sortedByLanguages = await ghStarFetch({
+  const opts: Partial<Options> = {
     accessToken: core.getInput('api-token', { required: true }),
-    compactByLanguage: true,
+  };
-  });
 
-  const rendered = await renderer(
+  const results = await ghStarFetch(opts);
+
+  const files = [];
+
+  const compactedByLanguage = compactByLanguage(results);
+  const byLanguage = await renderer(
     {
       username: REPO_USERNAME,
-      stars: Object.entries(sortedByLanguages),
+      stars: Object.entries(compactedByLanguage),
       updatedAt: Date.now(),
     },
     template
   );
 
-  const markdown: string = await generateMd(rendered);
+  files.push(
-
-  await pushNewFiles([
     {
       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) {

test/helpers.spec.ts

@@ -1,52 +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 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 { renderer, generateMd, pushNewFiles } from '../src/helpers';
-
-test('renderer should render', async (t) => {
-  const output = await renderer({ variable: 123 }, 'Test: <%= variable %>');
-  t.is(output, 'Test: 123');
-});
-
-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);
-});