fix: eslint prettier config, run lint and edit readme

Author: robertoentringer

.eslintrc.js

@@ -1,20 +1,16 @@
 module.exports = {
   env: {
-    commonjs: true,
-    es6: true,
     node: true,
+    commonjs: true,
+    es6: true
   },
-  extends: ["eslint:recommended", "plugin:prettier/recommended"],
-  globals: {
-    Atomics: "readonly",
-    SharedArrayBuffer: "readonly",
-  },
+  extends: ['eslint:recommended', 'plugin:prettier/recommended'],
+  plugins: ['prettier'],
   parserOptions: {
     ecmaVersion: 2018,
+    sourceType: 'module'
   },
-  plugins: ["prettier"],
   rules: {
-    "no-console": 0,
-    "prettier/prettier": ["error", { semi: false , printWidth: 100}],
-  },
+    'comma-dangle': ['error', 'never']
+  }
 }

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "none"
+}

README.md

@@ -2,9 +2,9 @@
 
 A Node script for extract data of the Lëtzebuerger Online Dictionnaire (LOD).
 
-Author : [Roberto Entringer](https://robertoentringer.com)  
-License: MIT  
-Npm package : https://www.npmjs.com/package/lod-extract   
+Author : [Roberto Entringer](https://robertoentringer.com)
+License: MIT
+Npm package : https://www.npmjs.com/package/lod-extract
 
 ## Installation / Usage
 
@@ -25,9 +25,9 @@ Node dependencies: [xml-flow](https://www.npmjs.com/package/xml-flow), [tar](htt
 
 # Data source
 
-Data from the "Lëtzebuerger Online Dictionnaire" (LOD)  
-Website: http://www.lod.lu  
-Source: https://data.public.lu/fr/datasets/letzebuerger-online-dictionnaire-raw-data/  
+Data from the "Lëtzebuerger Online Dictionnaire" (LOD)
+Website: http://www.lod.lu
+Source: https://data.public.lu/fr/datasets/letzebuerger-online-dictionnaire/
 Licence: Creative Commons Zero (CC0)
 
-[![screenshot.png](screenshot.png)](https://data.public.lu/fr/datasets/letzebuerger-online-dictionnaire-raw-data/)
+[![screenshot.png](screenshot.png)](https://data.public.lu/fr/datasets/letzebuerger-online-dictionnaire/)

main.js

@@ -1,14 +1,14 @@
 #! /usr/bin/env node
 
-const flow = require("xml-flow")
-const https = require("https")
-const path = require("path")
-const tar = require("tar")
-const fs = require("fs")
-
-const api = process.argv.slice(2).shift() ||
-  "https://data.public.lu/api/1/datasets/letzebuerger-online-dictionnaire/"
+const flow = require('xml-flow')
+const https = require('https')
+const path = require('path')
+const tar = require('tar')
+const fs = require('fs')
 
+const api =
+  process.argv.slice(2).shift() ||
+  'https://data.public.lu/api/1/datasets/letzebuerger-online-dictionnaire/'
 
 const regex = /\.xml$/
 const infos = { noAudio: [], smallFiles: [], writeFail: [], countAudio: 0, countJson: 0 }
@@ -21,56 +21,56 @@ const getURLfromAPI = () => {
     https
       .get(api, (resp) => {
         if (resp.statusCode !== 200)
-          return reject(new Error(resp.statusCode + " : " + resp.statusMessage))
-        let body = ""
-        resp.on("data", (data) => (body += data))
-        resp.on("end", () => {
+          return reject(new Error(resp.statusCode + ' : ' + resp.statusMessage))
+        let body = ''
+        resp.on('data', (data) => (body += data))
+        resp.on('end', () => {
           try {
             body = JSON.parse(body)
           } catch (err) {
             reject(err)
           }
           let [resources] = body.resources || []
-          if (resources && "url" in resources) resolve(resources.url)
-          else reject(new Error("URL ressource not found"))
+          if (resources && 'url' in resources) resolve(resources.url)
+          else reject(new Error('URL ressource not found'))
         })
       })
-      .on("error", (err) => reject(err))
+      .on('error', (err) => reject(err))
   })
 }
 
-const createFolders = (distFolder = "dist") => {
+const createFolders = (distFolder = 'dist') => {
   distFolder = path.join(process.cwd(), distFolder)
-  audioFolder = path.join(distFolder, "audio")
-  jsonFolder = path.join(distFolder, "json")
+  audioFolder = path.join(distFolder, 'audio')
+  jsonFolder = path.join(distFolder, 'json')
   const folders = [distFolder, audioFolder, jsonFolder]
   for (const folder of folders)
     if (!fs.existsSync(folder)) fs.mkdirSync(folder, { recursive: true })
 }
 
 const extract = (url) =>
   https.get(url, (resp) => {
-    console.info(`Extracting from : ${url}`, "\n")
-    resp.pipe(tar.t()).on("entry", (entry) => {
+    console.info(`Extracting from : ${url}`, '\n')
+    resp.pipe(tar.t()).on('entry', (entry) => {
       if (regex.test(entry.path)) parse(entry)
     })
   })
 
 const parse = (entry) => {
-  console.info(`Parsing from : ${entry.path}`, "\n")
+  console.info(`Parsing from : ${entry.path}`, '\n')
   return flow(entry)
-    .on("tag:lod:item", (item) => {
-      const id = item["lod:meta"]["lod:id"]
+    .on('tag:lod:item', (item) => {
+      const id = item['lod:meta']['lod:id']
       printProgress(id)
-      if ("lod:audio" in item && "$text" in item["lod:audio"]) {
-        const audio = item["lod:audio"]["$text"]
+      if ('lod:audio' in item && '$text' in item['lod:audio']) {
+        const audio = item['lod:audio']['$text']
         writeAudio(id, audio)
       } else infos.noAudio.push(id)
-      delete item["lod:audio"]
+      delete item['lod:audio']
       writeJson(id, item)
     })
-    .on("error", (err) => console.error(err))
-    .on("end", feedBack)
+    .on('error', (err) => console.error(err))
+    .on('end', feedBack)
 }
 
 const writeJson = (id, item) => {
@@ -87,7 +87,7 @@ const writeJson = (id, item) => {
 const writeAudio = (id, data) => {
   const filename = `${id}.mp3`
   const audioPath = path.join(audioFolder, filename)
-  const buff = new Buffer.from(data, "base64")
+  const buff = new Buffer.from(data, 'base64')
   if (buff.length < 1000) infos.smallFiles.push(id)
   try {
     fs.writeFileSync(audioPath, buff)
@@ -108,19 +108,19 @@ const feedBack = () => {
   const time = new Date(hrend[0] * 1000).toISOString().substr(11, 8)
   process.stdout.cursorTo(0)
   process.stdout.clearLine()
-  console.info("⦿ Execution time : %s", time)
-  console.info("√ Json files : %s", infos.countJson)
-  console.info("√ Mp3 files : %s", infos.countAudio)
-  console.info("☓ Items without audio : ", infos.noAudio.length, infos.noAudio)
-  console.info("⁈ Files very small : ", infos.smallFiles.length, infos.smallFiles, "\n")
+  console.info('⦿ Execution time : %s', time)
+  console.info('√ Json files : %s', infos.countJson)
+  console.info('√ Mp3 files : %s', infos.countAudio)
+  console.info('☓ Items without audio : ', infos.noAudio.length, infos.noAudio)
+  console.info('⁈ Files very small : ', infos.smallFiles.length, infos.smallFiles, '\n')
   process.exit()
 }
 
 const main = () => {
-  process.on("SIGINT", feedBack)
+  process.on('SIGINT', feedBack)
   getURLfromAPI()
     .then((url) => {
-      createFolders(path.basename(url).replace(".tar.gz", ""))
+      createFolders(path.basename(url).replace('.tar.gz', ''))
       extract(url)
     })
     .catch(console.error)