Add option to ignore languages/skip repositories in languages plugin (#22)

* Add option to ignore languages/skip repositories in languages plugin * Fix logs on error and first attempt to fix update of file larger than >1mb * Use variable branch name * Update version number
2020-12-15 20:46:00 +01:00
parent d057f20fa3
commit f9460d6159
10 changed files with 140 additions and 69 deletions
--- a/README.md
+++ b/README.md
@@ -731,6 +731,8 @@ Add the following to your workflow :
  with:
    # ... other options
    plugin_languages: yes
+    plugin_languages_ignored: "" # List of comma separated languages to ignore
+    plugin_languages_skipped: "" # List of comma separated repositories to skip
 ```

 </details>
--- a/action.yml
+++ b/action.yml
@@ -115,6 +115,18 @@ inputs:
    description: Enable most used languages metrics
    default: no

+  # List of ignored languages, comma separated
+  # Ignored languages won't count towards your languages metrics
+  plugin_languages_ignored:
+    description: List of ignored languages
+    default: ""
+
+  # List of skipped repositories, comma separated
+  # Skipped repositories won't count towards your languages metrics
+  plugin_languages_skipped:
+    description: List of skipped repositories
+    default: ""
+
  # Follow-up plugin
  # Display the number and the ratio of opened/closed issues and opened/merged pull requests on your repositories
  plugin_followup:
--- a/action/dist/index.js
+++ b/action/dist/index.js
--- a/action/index.mjs
+++ b/action/index.mjs
@@ -15,7 +15,7 @@
  //Runner
    try {
      //Initialization
-        console.log(`GitHub metrics as SVG image`)
+        console.log(`GitHub metrics`)
        console.log(`========================================================`)
        console.log(`Version                   | <#version>`)
        process.on("unhandledRejection", error => { throw error })
@@ -100,19 +100,26 @@
        //Pagespeed
          if (plugins.pagespeed.enabled) {
            plugins.pagespeed.token = core.getInput("plugin_pagespeed_token")
-            console.log(`Pagespeed token     | ${plugins.pagespeed.token ? "provided" : "missing"}`)
            q[`pagespeed.detailed`] = bool(core.getInput(`plugin_pagespeed_detailed`))
+            console.log(`Pagespeed token           | ${plugins.pagespeed.token ? "provided" : "missing"}`)
            console.log(`Pagespeed detailed        | ${q["pagespeed.detailed"]}`)
          }
+        //Languages
+          if (plugins.languages.enabled) {
+            for (const option of ["ignored", "skipped"])
+              q[`languages.${option}`] = core.getInput(`plugin_languages_${option}`) || null
+            console.log(`Languages ignored         | ${q["languages.ignored"]}`)
+            console.log(`Languages skipped repos   | ${q["languages.skipped"]}`)
+          }
        //Music
          if (plugins.music.enabled) {
+            plugins.music.token = core.getInput("plugin_music_token") || ""
            for (const option of ["provider", "mode", "playlist", "limit"])
              q[`music.${option}`] = core.getInput(`plugin_music_${option}`) || null
            console.log(`Music provider            | ${q["music.provider"]}`)
            console.log(`Music plugin mode         | ${q["music.mode"]}`)
            console.log(`Music playlist            | ${q["music.playlist"]}`)
            console.log(`Music tracks limit        | ${q["music.limit"]}`)
-            plugins.music.token = core.getInput("plugin_music_token") || ""
            console.log(`Music token               | ${plugins.music.token ? "provided" : "missing"}`)
          }
        //Posts
@@ -125,7 +132,7 @@
        //Isocalendar
          if (plugins.isocalendar.enabled) {
            q["isocalendar.duration"] = core.getInput("plugin_isocalendar_duration") ?? "half-year"
-            console.log(`Isocalendar duration| ${q["isocalendar.duration"]}`)
+            console.log(`Isocalendar duration      | ${q["isocalendar.duration"]}`)
          }
        //Topics
          if (plugins.topics.enabled) {
@@ -172,8 +179,10 @@
        if (dryrun)
          console.log(`Dry-run                   | complete`)
        else {
-          //Repository
+          //Repository and branch
+            const branch = github.context.ref.replace(/^refs[/]heads[/]/, "")
            console.log(`Repository                | ${github.context.repo.owner}/${github.context.repo.repo}`)
+            console.log(`Branch                    | ${branch}`)
          //Committer token
            const token = core.getInput("committer_token") || core.getInput("token")
            console.log(`Committer token           | ${token ? "provided" : "missing"}`)
@@ -189,9 +198,17 @@
            }
          //Retrieve previous render SHA to be able to update file content through API
            let sha = null
+            console.log(github.context.repo)
            try {
-              const {data} = await rest.repos.getContent({...github.context.repo, path:filename})
-              sha = data.sha
+              const {repository:{object:{oid}}} = await graphql(`
+                  query Sha {
+                    repository(owner: "${github.context.repo.owner}", name: "${github.context.repo.repo}") {
+                      object(expression: "${branch}:${filename}") { ... on Blob { oid } }
+                    }
+                  }
+                `
+              )
+              sha = oid
            } catch (error) { console.debug(error) }
            console.log(`Previous render sha       | ${sha || "none"}`)
          //Update file content through API
@@ -211,7 +228,7 @@
    } catch (error) {
      console.error(error)
      if (!bool(core.getInput("debug")))
-        console.debug("An error occured, logging debug message :", ...debugged)
+        console.log("An error occured, logging debug message :", ...debugged)
      core.setFailed(error.message)
      process.exit(1)
    }
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
 {
  "name": "metrics",
-  "version": "2.7.0-beta",
+  "version": "2.8.0",
  "lockfileVersion": 1,
  "requires": true,
  "dependencies": {
@@ -352,9 +352,9 @@
      }
    },
    "@types/node": {
-      "version": "14.14.12",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.12.tgz",
-      "integrity": "sha512-ASH8OPHMNlkdjrEdmoILmzFfsJICvhBsFfAum4aKZ/9U4B6M6tTmTPh+f3ttWdD74CEGV5XvXWkbyfSdXaTd7g=="
+      "version": "14.14.14",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.14.tgz",
+      "integrity": "sha512-UHnOPWVWV1z+VV8k6L1HhG7UbGBgIdghqF3l9Ny9ApPghbjICXkUJSd/b9gOgQfjM1r+37cipdw/HJ3F6ICEnQ=="
    },
    "@types/q": {
      "version": "1.5.4",
@@ -1349,9 +1349,9 @@
      }
    },
    "follow-redirects": {
-      "version": "1.13.0",
-      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.0.tgz",
-      "integrity": "sha512-aq6gF1BEKje4a9i9+5jimNFIpq4Q1WiwBToeRK5NvZBd/TRsmW8BsJfOEGkr76TbOyPVD3OVDN910EcUNtRYEA=="
+      "version": "1.13.1",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.1.tgz",
+      "integrity": "sha512-SSG5xmZh1mkPGyKzjZP8zLjltIfpW32Y5QpdNJyjcfGxK3qo3NDDkZOZSFiGn1A6SclQxY9GzEwAHQ3dmYRWpg=="
    },
    "forwarded": {
      "version": "0.1.2",
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "metrics",
-  "version": "2.8.0-beta",
+  "version": "2.8.0",
  "description": "Generate an user's GitHub metrics as SVG image format to embed somewhere else",
  "main": "index.mjs",
  "scripts": {
--- a/src/html/app.js
+++ b/src/html/app.js
@@ -43,6 +43,8 @@
              "base.metadata":"Metadata",
            },
            options:{
+              "languages.ignored":"",
+              "languages.skipped":"",
              "pagespeed.detailed":false,
              "habits.from":100,
              "music.playlist":"",
@@ -103,8 +105,9 @@
            action() {
              return [
                `# Visit https://github.com/lowlighter/metrics/blob/master/action.yml for full reference`,
-                `name: GitHub metrics as SVG image`,
+                `name: GitHub metrics`,
                `on:`,
+                `  # Schedule updates`,
                `  schedule: [{cron: "0 * * * *"}]`,
                `  push: {branches: "master"}`,
                `jobs:`,
@@ -113,16 +116,19 @@
                `    steps:`,
                `      - uses: lowlighter/metrics@latest`,
                `        with:`,
-                `          # Setup a personal token in your secrets.`,
+                `          # You'll need to setup a personal token in your secrets.`,
                `          token: ${"$"}{{ secrets.METRICS_TOKEN }}`,
-                `          # You can also setup a bot token for commits`,
-                `          # committer_token: ${"$"}{{ secrets.METRICS_BOT_TOKEN }}`,
+                `          # GITHUB_TOKEN is a special auto-generated token used for commits`,
+                `          committer_token: ${"$"}{{ secrets.GITHUB_TOKEN }}`,
                ``,
                `          # Options`,
                `          user: ${this.user }`,
                `          template: ${this.templates.selected}`,
-                `          base: ${Object.keys(this.plugins.enabled.base).join(", ") }`,
-                ...Object.entries(this.plugins.enabled).filter(([key, value]) => (key !== "base")&&(value)).map(([key]) => `          plugin_${key}: yes`)
+                `          base: ${Object.entries(this.plugins.enabled.base).filter(([key, value]) => value).map(([key]) => key).join(", ")||'""'}`,
+                ...[
+                  ...Object.entries(this.plugins.enabled).filter(([key, value]) => (key !== "base")&&(value)).map(([key]) => `          plugin_${key}: yes`),
+                  ...Object.entries(this.plugins.options).filter(([key, value]) => value).filter(([key, value]) => this.plugins.enabled[key.split(".")[0]]).map(([key, value]) => `          plugin_${key.replace(/[.]/, "_")}: ${typeof value === "boolean" ? {true:"yes", false:"no"}[value] : value}`)
+                ].sort(),
              ].join("\n")
            }
        },
--- a/src/html/index.html
+++ b/src/html/index.html
@@ -51,7 +51,7 @@
                  </label>
                </div>
                <i>*Additional plugins may be available when used as GitHub Action</i>
-                <template v-if="(plugins.enabled.music)||(plugins.enabled.pagespeed)||(plugins.enabled.habits)||(plugins.enabled.posts)||(plugins.enabled.isocalendar)||(plugins.enabled.projects)||(plugins.enabled.topics)">
+                <template v-if="(plugins.enabled.music)||(plugins.enabled.pagespeed)||(plugins.enabled.languages)||(plugins.enabled.habits)||(plugins.enabled.posts)||(plugins.enabled.isocalendar)||(plugins.enabled.projects)||(plugins.enabled.topics)">
                  <h3>2.3 Configure additional plugins</h3>
                  <div class="options">
                    <div class="options-group" v-if="plugins.enabled.music">
@@ -72,6 +72,17 @@
                        <input type="checkbox" v-model="plugins.options['pagespeed.detailed']" @change="load">
                      </label>
                    </div>
+                    <div class="options-group" v-if="plugins.enabled.languages">
+                      <h4>{{ plugins.descriptions.languages }}</h4>
+                      <label>
+                        Ignored languages (comma separated)
+                        <input type="text" v-model="plugins.options['languages.ignored']" @change="load">
+                      </label>
+                      <label>
+                        Skipped repositories (comma separated)
+                        <input type="text" v-model="plugins.options['languages.skipped']" @change="load">
+                      </label>
+                    </div>
                    <div class="options-group" v-if="plugins.enabled.habits">
                      <h4>{{ plugins.descriptions.habits }}</h4>
                      <label>
--- a/src/plugins/languages/index.mjs
+++ b/src/plugins/languages/index.mjs
@@ -1,14 +1,32 @@
 //Setup
-  export default async function ({data, q}, {enabled = false} = {}) {
+  export default async function ({login, data, q}, {enabled = false} = {}) {
    //Plugin execution
      try {
        //Check if plugin is enabled and requirements are met
          if ((!enabled)||(!q.languages))
            return null
+        //Parameters override
+          let {"languages.ignored":ignored = "", "languages.skipped":skipped = ""} = q
+          //Ignored languages
+            ignored = decodeURIComponent(ignored).split(",").map(x => x.trim().toLocaleLowerCase()).filter(x => x)
+          //Skipped repositories
+            skipped = decodeURIComponent(skipped).split(",").map(x => x.trim().toLocaleLowerCase()).filter(x => x)
        //Iterate through user's repositories and retrieve languages data
          const languages = {colors:{}, total:0, stats:{}}
          for (const repository of data.user.repositories.nodes) {
+            //Skip repository if asked
+              if (skipped.includes(repository.name.toLocaleLowerCase())) {
+                console.debug(`metrics/compute/${login}/plugins > languages > skipped repository ${repository.name}`)
+                continue
+              }
+            //Process repository languages
              for (const {size, node:{color, name}} of Object.values(repository.languages.edges)) {
+                //Ignore language if asked
+                  if (ignored.includes(name.toLocaleLowerCase())) {
+                    console.debug(`metrics/compute/${login}/plugins > languages > ignored language ${name}`)
+                    continue
+                  }
+                //Update language stats
                  languages.stats[name] = (languages.stats[name] ?? 0) + size
                  languages.colors[name] = color ?? "#ededed"
                  languages.total += size
--- a/src/plugins/music/index.mjs
+++ b/src/plugins/music/index.mjs
@@ -129,7 +129,6 @@
                                `${new imports.url.URLSearchParams({grant_type:"refresh_token", refresh_token, client_id, client_secret})}`,
                                {headers:{"Content-Type":"application/x-www-form-urlencoded"}},
                              )
-                              console.log(access)
                              console.debug(`metrics/compute/${login}/plugins > music > got new access token`)
                            //Retriev tracks
                              tracks = (await imports.axios(`https://api.spotify.com/v1/me/player/recently-played?limit=${limit}&after=${timestamp}`, {headers:{