feat: add eslint support

.github/workflows/test-workflow.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         node-version: [16.x, 18.x, 20.x]
-        flags: ["", "-t"]
+        flags: ["", "-t", "-l", "-t -l"]
 
     steps:
       - name: Checkout
@@ -35,6 +35,11 @@ jobs:
         run: npx create-react-sandbox ${{ matrix.flags }}
         working-directory: ./temp
 
+      - name: Run linter
+        if: ${{ contains(matrix.flags, '-l') }}
+        run: npx eslint
+        working-directory: ./temp/app
+
       - name: Run Package Build Script
         run: npm run build
         working-directory: ./temp/app

bin/index.js

@@ -67,6 +67,29 @@ function installDependencies(sandboxDirectory, onData, onErr, onExit) {
     npmInit.on('exit', onExit)
 }
 
+/**
+ * Configure Eslint depending on specification
+ * @param sandboxDirectory the name of the directory housing the sandbox
+ * @param isTypescript if the sandbox uses typescript or not
+ * @param isEslint if the sandbox uses eslint or not
+ */
+async function handleEslint(sandboxDirectory, isTypescript, isEslint) {
+    if (!isEslint) {
+	await fs.unlink(path.join(sandboxDirectory, 'eslint.config.js'))
+	return
+    }
+
+    await modifyFile(path.join(sandboxDirectory, 'package.json'), (packageJson) => {
+	const packageObject = JSON.parse(packageJson)
+	packageObject.devDependencies['eslint'] = '^8.57.0'
+	packageObject.devDependencies['@eslint/js'] = '^9.0.0'
+	if (isTypescript) {
+	    packageObject.devDependencies['typescript-eslint'] = '^7.6.0'
+	}
+	return JSON.stringify(packageObject, null, 2)
+    })
+}
+
 /**
  * Run the main thread of the program
  */
@@ -93,6 +116,8 @@ async function main() {
         jsonObject.name = sandboxDirectory
         return JSON.stringify(jsonObject, null, 2)
     })
+
+    await handleEslint(sandboxDirectory, isTypescript, isEslint)
 
     loadingSpinner.stop()
     process.stdout.write('\rInitialized the sandbox!\n')
@@ -121,3 +146,4 @@ main().catch((err) => {
     loadingSpinner.stop()
     console.log('\n' + err.message)
 })
+

bin/static/js/eslint.config.js

@@ -0,0 +1,14 @@
+import js from '@eslint/js'
+
+export default [
+	js.configs.recommended,
+	{
+	    ignores: ['**/dist/**'],
+	    languageOptions: {
+	        globals: {
+		    "process": true,
+		},
+	    },
+	},
+]
+

bin/static/js/package.json

@@ -11,6 +11,7 @@
     "keywords": [],
     "author": "",
     "license": "ISC",
+    "type": "module",
     "dependencies": {
       "react": "^18.2.0",
       "react-dom": "^18.2.0"
@@ -25,4 +26,4 @@
       "webpack-dev-server": "^4.11.1"
     }
   }
-
+

bin/static/js/webpack.config.js

@@ -1,7 +1,11 @@
-const path = require("path")
-const HtmlWebpackPlugin = require('html-webpack-plugin')
+import path from 'path'
+import { fileURLToPath } from 'url'
+import HtmlWebpackPlugin from 'html-webpack-plugin'
 
-module.exports = {
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+export default {
     mode: process.env.NODE_ENV ?? "development", 
     entry: "./src/index.jsx", 
     plugins: [

bin/static/ts/eslint.config.js

@@ -0,0 +1,17 @@
+// @ts-check
+
+import eslint from '@eslint/js'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+	{
+	    ignores: ['**/dist/**'],
+	    languageOptions: {
+	        globals: {
+		    "process": true,
+		},
+	    },
+	},
+	eslint.configs.recommended,
+	...tseslint.configs.recommended,
+)

bin/static/ts/package.json

@@ -12,6 +12,7 @@
     "keywords": [],
     "author": "",
     "license": "ISC",
+    "type": "module",
     "dependencies": {
         "react": "^18.2.0",
         "react-dom": "^18.2.0"
@@ -29,4 +30,4 @@
         "webpack-cli": "^5.0.1",
         "webpack-dev-server": "^4.11.1"
     }
-}
+}

bin/static/ts/webpack.config.js

@@ -1,8 +1,11 @@
+import path from 'path'
+import { fileURLToPath } from 'url'
+import HtmlWebpackPlugin from 'html-webpack-plugin'
 
-const path = require("path")
-const HtmlWebpackPlugin = require('html-webpack-plugin')
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
 
-module.exports = {
+export default {
     mode: process.env.NODE_ENV ?? "development", 
     entry: "./src/index.tsx", 
     plugins: [
@@ -39,3 +42,4 @@ module.exports = {
         ]
     }
 }
+