chore: code formatting

Author: github-actions[bot]

.github/scripts/build.mjs

@@ -1,12 +1,12 @@
 //Imports
-import ejs from "ejs"
 import fs from "fs/promises"
+import ejs from "ejs"
 import fss from "fs"
+import yaml from "js-yaml"
 import paths from "path"
-import url from "url"
 import sgit from "simple-git"
+import url from "url"
 import metadata from "../../source/app/metrics/metadata.mjs"
-import yaml from "js-yaml"
 
 //Mode
 const [mode = "dryrun"] = process.argv.slice(2)
@@ -25,34 +25,36 @@ const __test_secrets = paths.join(paths.join(__metrics, "tests/secrets.json"))
 //Git setup
 const git = sgit(__metrics)
 const staged = new Set()
-const secrets = Object.assign(JSON.parse(`${await fs.readFile(__test_secrets)}`), {$regex:/\$\{\{\s*secrets\.(?<secret>\w+)\s*\}\}/})
-const {plugins, templates} = await metadata({log:false, diff:true})
+const secrets = Object.assign(JSON.parse(`${await fs.readFile(__test_secrets)}`), { $regex: /\$\{\{\s*secrets\.(?<secret>\w+)\s*\}\}/ })
+const { plugins, templates } = await metadata({ log: false, diff: true })
 const workflow = []
 
 //Config and general documentation auto-generation
 for (const step of ["config", "documentation"]) {
   switch (step) {
     case "config":
-      await update({source:paths.join(__action, "action.yml"), output:"action.yml"})
-      await update({source:paths.join(__web, "settings.example.json"), output:"settings.example.json"})
+      await update({ source: paths.join(__action, "action.yml"), output: "action.yml" })
+      await update({ source: paths.join(__web, "settings.example.json"), output: "settings.example.json" })
       break
     case "documentation":
-      await update({source:paths.join(__readme, "README.md"), output:"README.md", options:{root:__readme}})
-      await update({source:paths.join(__readme, "partials/documentation/plugins.md"), output:"source/plugins/README.md"})
-      await update({source:paths.join(__readme, "partials/documentation/templates.md"), output:"source/templates/README.md"})
+      await update({ source: paths.join(__readme, "README.md"), output: "README.md", options: { root: __readme } })
+      await update({ source: paths.join(__readme, "partials/documentation/plugins.md"), output: "source/plugins/README.md" })
+      await update({ source: paths.join(__readme, "partials/documentation/templates.md"), output: "source/templates/README.md" })
       break
   }
 }
 
 //Plugins
 for (const id of Object.keys(plugins)) {
-  const {examples, options, readme, tests, header} = await plugin(id)
+  const { examples, options, readme, tests, header } = await plugin(id)
 
   //Readme
-  await fs.writeFile(readme.path, readme.content
-    .replace(/(<!--header-->)[\s\S]*(<!--\/header-->)/g, `$1\n${header}\n$2`)
-    .replace(/(<!--examples-->)[\s\S]*(<!--\/examples-->)/g, `$1\n${examples.map(({test, prod, ...step}) => ["```yaml", yaml.dump(step), "```"].join("\n")).join("\n")}\n$2`)
-    .replace(/(<!--options-->)[\s\S]*(<!--\/options-->)/g, `$1\n${options}\n$2`)
+  await fs.writeFile(
+    readme.path,
+    readme.content
+      .replace(/(<!--header-->)[\s\S]*(<!--\/header-->)/g, `$1\n${header}\n$2`)
+      .replace(/(<!--examples-->)[\s\S]*(<!--\/examples-->)/g, `$1\n${examples.map(({ test, prod, ...step }) => ["```yaml", yaml.dump(step), "```"].join("\n")).join("\n")}\n$2`)
+      .replace(/(<!--options-->)[\s\S]*(<!--\/options-->)/g, `$1\n${options}\n$2`),
   )
   console.log(`Generating source/plugins/${id}/README.md`)
 
@@ -64,12 +66,14 @@ for (const id of Object.keys(plugins)) {
 
 //Templates
 for (const id of Object.keys(templates)) {
-  const {examples, readme, tests, header} = await template(id)
+  const { examples, readme, tests, header } = await template(id)
 
   //Readme
-  await fs.writeFile(readme.path, readme.content
-    .replace(/(<!--header-->)[\s\S]*(<!--\/header-->)/g, `$1\n${header}\n$2`)
-    .replace(/(<!--examples-->)[\s\S]*(<!--\/examples-->)/g, `$1\n${examples.map(({test, prod, ...step}) => ["```yaml", yaml.dump(step), "```"].join("\n")).join("\n")}\n$2`)
+  await fs.writeFile(
+    readme.path,
+    readme.content
+      .replace(/(<!--header-->)[\s\S]*(<!--\/header-->)/g, `$1\n${header}\n$2`)
+      .replace(/(<!--examples-->)[\s\S]*(<!--\/examples-->)/g, `$1\n${examples.map(({ test, prod, ...step }) => ["```yaml", yaml.dump(step), "```"].join("\n")).join("\n")}\n$2`),
   )
   console.log(`Generating source/templates/${id}/README.md`)
 
@@ -80,7 +84,7 @@ for (const id of Object.keys(templates)) {
 }
 
 //Example workflows
-await update({source:paths.join(__metrics, ".github/scripts/files/examples.yml"), output:".github/workflows/examples.yml", context:{steps:yaml.dump(workflow)}})
+await update({ source: paths.join(__metrics, ".github/scripts/files/examples.yml"), output: ".github/workflows/examples.yml", context: { steps: yaml.dump(workflow) } })
 
 //Commit and push
 if (mode === "publish") {
@@ -98,10 +102,10 @@ console.log("Success!")
 //==================================================================================
 
 //Update generated files
-async function update({source, output, context = {}, options = {}}) {
+async function update({ source, output, context = {}, options = {} }) {
   console.log(`Generating ${output}`)
-  const {plugins, templates, packaged, descriptor} = await metadata({log:false})
-  const content = await ejs.renderFile(source, {plugins, templates, packaged, descriptor, ...context}, {async:true, ...options})
+  const { plugins, templates, packaged, descriptor } = await metadata({ log: false })
+  const content = await ejs.renderFile(source, { plugins, templates, packaged, descriptor, ...context }, { async: true, ...options })
   const file = paths.join(__metrics, output)
   await fs.writeFile(file, content)
   staged.add(file)
@@ -114,16 +118,16 @@ async function plugin(id) {
   const examples = paths.join(path, "examples.yml")
   const tests = paths.join(__test_cases, `${id}.plugin.yml`)
   return {
-    readme:{
-      path:readme,
-      content:`${await fs.readFile(readme)}`
+    readme: {
+      path: readme,
+      content: `${await fs.readFile(readme)}`,
     },
-    tests:{
-      path:tests
+    tests: {
+      path: tests,
     },
-    examples:fss.existsSync(examples) ? yaml.load(await fs.readFile(examples), "utf8") ?? [] : [],
-    options:plugins[id].readme.table,
-    header:plugins[id].readme.header
+    examples: fss.existsSync(examples) ? yaml.load(await fs.readFile(examples), "utf8") ?? [] : [],
+    options: plugins[id].readme.table,
+    header: plugins[id].readme.header,
   }
 }
 
@@ -134,45 +138,45 @@ async function template(id) {
   const examples = paths.join(path, "examples.yml")
   const tests = paths.join(__test_cases, `${id}.template.yml`)
   return {
-    readme:{
-      path:readme,
-      content:`${await fs.readFile(readme)}`
+    readme: {
+      path: readme,
+      content: `${await fs.readFile(readme)}`,
     },
-    tests:{
-      path:tests
+    tests: {
+      path: tests,
     },
-    examples:fss.existsSync(examples) ? yaml.load(await fs.readFile(examples), "utf8") ?? [] : [],
-    header:templates[id].readme.header
+    examples: fss.existsSync(examples) ? yaml.load(await fs.readFile(examples), "utf8") ?? [] : [],
+    header: templates[id].readme.header,
   }
 }
 
 //Testcase generator
 function testcase(name, env, args) {
-  const {prod = {}, test = {}, ...step} = JSON.parse(JSON.stringify(args))
-  const context = {prod, test}[env] ?? {}
+  const { prod = {}, test = {}, ...step } = JSON.parse(JSON.stringify(args))
+  const context = { prod, test }[env] ?? {}
   if (context.skip)
     return null
 
   Object.assign(step.with, context.with ?? {})
   delete context.with
-  const result = {...step, ...context, name:`${name} - ${step.name ?? "(unnamed)"}`}
+  const result = { ...step, ...context, name: `${name} - ${step.name ?? "(unnamed)"}` }
   for (const [k, v] of Object.entries(result.with)) {
-    if ((env === "test")&&(secrets.$regex.test(v)))
+    if ((env === "test") && (secrets.$regex.test(v)))
       result.with[k] = v.replace(secrets.$regex, secrets[v.match(secrets.$regex)?.groups?.secret])
   }
 
   if (env === "prod") {
     result.if = "${{ success() || failure() }}"
     result.uses = "lowlighter/metrics@master"
-    Object.assign(result.with, {plugins_errors_fatal:"yes", output_action:"none", delay:120})
+    Object.assign(result.with, { plugins_errors_fatal: "yes", output_action: "none", delay: 120 })
   }
 
   if (env === "test") {
     if (!result.with.base)
       delete result.with.base
     delete result.with.filename
-    Object.assign(result.with, {use_mocked_data:"yes", verify:"yes"})
+    Object.assign(result.with, { use_mocked_data: "yes", verify: "yes" })
   }
 
   return result
-}
+}

.github/scripts/markdown_example.mjs

@@ -3,19 +3,19 @@ import puppeteer from "puppeteer"
 
 //Setup browser
 const browser = await puppeteer.launch({
-  headless:true,
-  executablePath:process.env.PUPPETEER_BROWSER_PATH,
-  args:["--no-sandbox", "--disable-extensions", "--disable-setuid-sandbox", "--disable-dev-shm-usage"],
-  ignoreDefaultArgs:["--disable-extensions"],
+  headless: true,
+  executablePath: process.env.PUPPETEER_BROWSER_PATH,
+  args: ["--no-sandbox", "--disable-extensions", "--disable-setuid-sandbox", "--disable-dev-shm-usage"],
+  ignoreDefaultArgs: ["--disable-extensions"],
 })
 const page = await browser.newPage()
 
 //Select markdown example and take screenshoot
-await page.setViewport({width:600, height:600})
+await page.setViewport({ width: 600, height: 600 })
 await page.goto("https://github.com/lowlighter/metrics/blob/examples/metrics.markdown.md")
 const clip = await page.evaluate(() => {
-  const {x, y, width, height} = document.querySelector("#readme").getBoundingClientRect()
-  return {x, y, width, height}
+  const { x, y, width, height } = document.querySelector("#readme").getBoundingClientRect()
+  return { x, y, width, height }
 })
-await page.screenshot({type:"png", path:"metrics.markdown.png", clip, omitBackground:true})
+await page.screenshot({ type: "png", path: "metrics.markdown.png", clip, omitBackground: true })
 await browser.close()

.github/scripts/preview.mjs

@@ -19,35 +19,36 @@ const __preview_templates_ = paths.join(__preview, ".templates_")
 const __preview_about = paths.join(__preview, "about/.statics")
 
 //Extract from web server
-const {conf, Templates} = await setup({nosettings:true, log:false})
-const templates = Object.entries(Templates).map(([name]) => ({name, enabled:true}))
-const metadata = Object.fromEntries(Object.entries(conf.metadata.plugins)
-  .map(([key, value]) => [key, Object.fromEntries(Object.entries(value).filter(([key]) => ["name", "icon", "category", "web", "supports"].includes(key)))])
-  .map(([key, value]) => [key, key === "core" ? {...value, web:Object.fromEntries(Object.entries(value.web).filter(([key]) => /^config[.]/.test(key)).map(([key, value]) => [key.replace(/^config[.]/, ""), value]))} : value]))
-
+const { conf, Templates } = await setup({ nosettings: true, log: false })
+const templates = Object.entries(Templates).map(([name]) => ({ name, enabled: true }))
+const metadata = Object.fromEntries(
+  Object.entries(conf.metadata.plugins)
+    .map(([key, value]) => [key, Object.fromEntries(Object.entries(value).filter(([key]) => ["name", "icon", "category", "web", "supports"].includes(key)))])
+    .map(([key, value]) => [key, key === "core" ? { ...value, web: Object.fromEntries(Object.entries(value.web).filter(([key]) => /^config[.]/.test(key)).map(([key, value]) => [key.replace(/^config[.]/, ""), value])) } : value]),
+)
 
 //Directories
-await fs.mkdir(__preview, {recursive:true})
-await fs.mkdir(__preview_js, {recursive:true})
-await fs.mkdir(__preview_css, {recursive:true})
-await fs.mkdir(__preview_templates, {recursive:true})
-await fs.mkdir(__preview_templates_, {recursive:true})
-await fs.mkdir(__preview_about, {recursive:true})
+await fs.mkdir(__preview, { recursive: true })
+await fs.mkdir(__preview_js, { recursive: true })
+await fs.mkdir(__preview_css, { recursive: true })
+await fs.mkdir(__preview_templates, { recursive: true })
+await fs.mkdir(__preview_templates_, { recursive: true })
+await fs.mkdir(__preview_about, { recursive: true })
 
 //Web
 fs.copyFile(paths.join(__web, "index.html"), paths.join(__preview, "index.html"))
 fs.copyFile(paths.join(__web, "favicon.png"), paths.join(__preview, ".favicon.png"))
 fs.copyFile(paths.join(__web, "opengraph.png"), paths.join(__preview, ".opengraph.png"))
 //Plugins and templates
-fs.writeFile(paths.join(__preview, ".plugins"), JSON.stringify(Object.entries(metadata).filter(([_name, {category}]) => category !== "core").map(([name]) => ({name, enabled:false}))))
+fs.writeFile(paths.join(__preview, ".plugins"), JSON.stringify(Object.entries(metadata).filter(([_name, { category }]) => category !== "core").map(([name]) => ({ name, enabled: false }))))
 fs.writeFile(paths.join(__preview, ".plugins.base"), JSON.stringify(conf.settings.plugins.base.parts))
 fs.writeFile(paths.join(__preview, ".plugins.metadata"), JSON.stringify(metadata))
 fs.writeFile(paths.join(__preview, ".templates__"), JSON.stringify(templates))
 for (const template in conf.templates) {
   fs.writeFile(paths.join(__preview_templates_, template), JSON.stringify(conf.templates[template]))
   const __partials = paths.join(__templates, template, "partials")
   const __preview_partials = paths.join(__preview_templates, template, "partials")
-  await fs.mkdir(__preview_partials, {recursive:true})
+  await fs.mkdir(__preview_partials, { recursive: true })
   for (const file of await fs.readdir(__partials))
     fs.copyFile(paths.join(__partials, file), paths.join(__preview_partials, file))
 }
@@ -71,9 +72,10 @@ fs.copyFile(paths.join(__node_modules, "prismjs/components/prism-markdown.min.js
 fs.copyFile(paths.join(__node_modules, "clipboard/dist/clipboard.min.js"), paths.join(__preview_js, "clipboard.min.js"))
 //Meta
 fs.writeFile(paths.join(__preview, ".version"), JSON.stringify(`${conf.package.version}-preview`))
-fs.writeFile(paths.join(__preview, ".hosted"), JSON.stringify({by:"metrics", link:"https://github.com/lowlighter/metrics"}))
+fs.writeFile(paths.join(__preview, ".hosted"), JSON.stringify({ by: "metrics", link: "https://github.com/lowlighter/metrics" }))
 //About
 fs.copyFile(paths.join(__web, "about", "index.html"), paths.join(__preview, "about", "index.html"))
-for (const file of await fs.readdir(__web_about))
+for (const file of await fs.readdir(__web_about)) {
   if (file !== ".statics")
     fs.copyFile(paths.join(__web_about, file), paths.join(__preview_about, file))
+}

.github/scripts/release.mjs

@@ -1,8 +1,8 @@
 //Imports
 import github from "@actions/github"
 import paths from "path"
-import url from "url"
 import sgit from "simple-git"
+import url from "url"
 
 //Git setup
 const __metrics = paths.join(paths.dirname(url.fileURLToPath(import.meta.url)), "../..")
@@ -18,16 +18,16 @@ const repository = process.env.GITHUB_REPOSITORY.match(/^(?<owner>[\s\S]+)[/](?<
 const version = process.env.GITHUB_COMMIT_MESSAGE.match(/(?<version>v\d+[.]\d+)/)?.groups?.version ?? null
 
 //Check arguments
-if ((!repository)||(!repository.name)||(!repository.owner))
+if ((!repository) || (!repository.name) || (!repository.owner))
   throw new Error(`Could not parse repository "${process.env.GITHUB_REPOSITORY}"`)
 console.log(`Repository: ${repository.owner}/${repository.name}`)
 if (!version)
   throw new Error(`Could not parse version from "${process.env.GITHUB_COMMIT_MESSAGE}"`)
 console.log(`Version: ${version}`)
 
 //Load related pr
-const {data:{items:prs}} = await rest.search.issuesAndPullRequests({
-  q:`repo:${repository.owner}/${repository.name} is:pr is:merged author:${maintainer} assignee:${maintainer} Release ${version} in:title`
+const { data: { items: prs } } = await rest.search.issuesAndPullRequests({
+  q: `repo:${repository.owner}/${repository.name} is:pr is:merged author:${maintainer} assignee:${maintainer} Release ${version} in:title`,
 })
 
 //Ensure that there is exactly one pr matching
@@ -40,17 +40,17 @@ console.log(`Using pr#${patchnote.number}: ${patchnote.title}`)
 
 //Check whether release already exists
 try {
-  const {data:{id}} = await rest.repos.getReleaseByTag({owner:repository.owner, repo:repository.name, tag:version})
+  const { data: { id } } = await rest.repos.getReleaseByTag({ owner: repository.owner, repo: repository.name, tag: version })
   console.log(`Release ${version} already exists (#${id}), will replace it`)
-  await rest.repos.deleteRelease({owner:repository.owner, repo:repository.name, release_id:id})
+  await rest.repos.deleteRelease({ owner: repository.owner, repo: repository.name, release_id: id })
   console.log(`Deleting tag ${version}`)
   await git.push(["--delete", "origin", version])
-  await new Promise(solve => setTimeout(solve, 15*1000))
+  await new Promise(solve => setTimeout(solve, 15 * 1000))
 }
 catch {
   console.log(`Release ${version} does not exists yet, will create it`)
 }
 
 //Publish release
-await rest.repos.createRelease({owner:repository.owner, repo:repository.name, tag_name:version, name:`Version ${version.replace(/^v/g, "")}`, body:patchnote.body})
+await rest.repos.createRelease({ owner: repository.owner, repo: repository.name, tag_name: version, name: `Version ${version.replace(/^v/g, "")}`, body: patchnote.body })
 console.log(`Successfully published`)

source/app/action/index.mjs

@@ -3,12 +3,12 @@ import core from "@actions/core"
 import github from "@actions/github"
 import octokit from "@octokit/graphql"
 import fs from "fs/promises"
+import processes from "child_process"
 import paths from "path"
 import sgit from "simple-git"
-import processes from "child_process"
+import mocks from "../../../tests/mocks/index.mjs"
 import metrics from "../metrics/index.mjs"
 import setup from "../metrics/setup.mjs"
-import mocks from "../../../tests/mocks/index.mjs"
 process.on("unhandledRejection", error => {
   throw error
 })
@@ -278,8 +278,8 @@ async function retry(func, {retries = 1, delay = 0} = {}) {
       try {
         await new Promise(async (solve, reject) => {
           let stdout = ""
-          setTimeout(() => reject("Timeout while waiting for Insights webserver"), 5*60*1000)
-          const web = await processes.spawn("node", ["/metrics/source/app/web/index.mjs"], {env:{...process.env, NO_SETTINGS: true }})
+          setTimeout(() => reject("Timeout while waiting for Insights webserver"), 5 * 60 * 1000)
+          const web = await processes.spawn("node", ["/metrics/source/app/web/index.mjs"], {env:{...process.env, NO_SETTINGS:true}})
           web.stdout.on("data", data => (console.debug(`web > ${data}`), stdout += data, /Server ready !/.test(stdout) ? solve() : null))
           web.stderr.on("data", data => console.debug(`web > ${data}`))
         })
@@ -339,7 +339,7 @@ async function retry(func, {retries = 1, delay = 0} = {}) {
     info.break()
     info.section("Saving")
     info("Output condition", _output_condition)
-    if ((_output_condition === "data-changed")&&((committer.commit) || (committer.pr))) {
+    if ((_output_condition === "data-changed") && ((committer.commit) || (committer.pr))) {
       const {svg} = await import("../metrics/utils.mjs")
       let data = ""
       await retry(async () => {
@@ -485,6 +485,7 @@ async function retry(func, {retries = 1, delay = 0} = {}) {
           }
           else
             throw error
+
         }
         info("Pull request number", number)
       }, {retries:retries_output_action, delay:retries_delay_output_action})
@@ -532,7 +533,7 @@ async function retry(func, {retries = 1, delay = 0} = {}) {
     if (delay) {
       info.break()
       info("Delay before ending job", `${delay}s`)
-      await new Promise(solve => setTimeout(solve, delay*1000))
+      await new Promise(solve => setTimeout(solve, delay * 1000))
     }
 
     //Success