Skip to content

Commit

Permalink
maint: Drop webpack in favor of esbuild
Browse files Browse the repository at this point in the history
For eslint integration there are two existing plugins [1], [2]
but none can be used because of unsatisfied peer dependency version of
esbuild. Let's just use our own eslint plugin for now.

[1] to-codando/esbuild-plugin-linter#1
[2] robinloeffel/esbuild-plugin-eslint#5

TODO:
[ ] cockpit-po-plugin
[ ] cockpit-rsync-plugin
[ ] stylelint intergration
[ ] fail on warnings eslint [0]

[0] eslint/eslint#16804
  • Loading branch information
KKoukiou committed Feb 14, 2023
1 parent 7d66688 commit d43945d
Show file tree
Hide file tree
Showing 8 changed files with 118 additions and 207 deletions.
9 changes: 2 additions & 7 deletions .eslintrc.json
Expand Up @@ -2,16 +2,11 @@
"root": true,
"env": {
"browser": true,
"es6": true
"es2022": true
},
"extends": ["eslint:recommended", "standard", "standard-jsx", "standard-react", "plugin:jsx-a11y/recommended"],
"parser": "@babel/eslint-parser",
"parserOptions": {
"ecmaVersion": "7",
"ecmaFeatures": {
"jsx": true
},
"sourceType": "module"
"ecmaVersion": 2022
},
"plugins": ["flowtype", "react", "react-hooks", "jsx-a11y"],
"rules": {
Expand Down
9 changes: 5 additions & 4 deletions Makefile
Expand Up @@ -91,11 +91,12 @@ packaging/arch/PKGBUILD: packaging/arch/PKGBUILD.in
packaging/debian/changelog: packaging/debian/changelog.in
sed 's/VERSION/$(VERSION)/' $< > $@

$(WEBPACK_TEST): $(COCKPIT_REPO_STAMP) $(shell find src/ -type f) package.json webpack.config.js
$(MAKE) package-lock.json && NODE_ENV=$(NODE_ENV) node_modules/.bin/webpack
# In development mode terser does not run and so no LICENSE.txt.gz is generated, so we explictly create it as it is required for building rpm's
$(WEBPACK_TEST): $(COCKPIT_REPO_STAMP) $(shell find src/ -type f) package.json build.js
$(MAKE) package-lock.json && NODE_ENV=$(NODE_ENV) npm run build
# In development mode minification does not run and so no LEGAL.txt is generated, so we explictly create it as it is required for building rpm's
if [ "$$NODE_ENV" = "development" ]; then \
gzip </dev/null >dist/index.js.LICENSE.txt.gz; \
touch dist/index.js.LEGAL.txt; \
touch dist/index.css.LEGAL.txt; \
fi

watch:
Expand Down
65 changes: 65 additions & 0 deletions build.js
@@ -0,0 +1,65 @@
import copy from 'esbuild-plugin-copy';
import fs from "fs";
import esbuild from "esbuild";
import path from "path";
import { sassPlugin } from 'esbuild-sass-plugin';
import { eslintPlugin } from './esbuild-eslint-plugin.js';

const useEslint = process.env.ESLINT !== '0';
const production = process.env.NODE_ENV === 'production';

const nodePaths=['pkg/lib']

const context = await esbuild.context({
// Cockpit's http server is not able to load multiple JS files
bundle: true,
entryPoints: ["./src/index.js"],
// Allow external font files which live in ../../static/fonts
external: ['*.woff', '*.woff2', '*.jpg', '*.svg', '../../assets*'],
// Move all legal comments to a .LEGAL.txt file
legalComments: 'external',
loader: { ".js": "jsx" },
minify: production,
// List of directories to use when resolving import statements
nodePaths,
outdir: "./dist",
... !production ? { sourcemap: "external" } : {},
target: ['es2020'],
logLevel: "debug",
plugins: [
... useEslint ? [eslintPlugin] : [],
// Esbuild will only copy assets that are explicitly imported and used
// in the code. This is a problem for index.html and manifest.json which are not imported
copy({
assets: [
{ from: ['./src/manifest.json'], to: [ './manifest.json' ] },
{ from: ['./src/index.html'], to: ['./index.html'] },
]
}),
sassPlugin({
loadPaths: [...nodePaths, 'node_modules'], quietDeps: true,
async transform(source, resolveDir, path) {
if (path.includes('patternfly-4-cockpit.scss')) {
return source
.replace(/url.*patternfly-icons-fake-path.*;/g, 'url("../base1/fonts/patternfly.woff") format("woff");')
.replace(/@font-face[^}]*patternfly-fonts-fake-path[^}]*}/g, '');
}
return source;
}
}),
]
})

// Manually do an incremental build
const result = await context.rebuild()

/* development options for faster iteration */
const watchMode = process.env.ESBUILD_WATCH === "true" || false;
if(watchMode) {
console.log("Running in watch mode");
// Enable watch mode
await context.watch()
}
else {
context.dispose();
}
28 changes: 28 additions & 0 deletions esbuild-eslint-plugin.js
@@ -0,0 +1,28 @@
// FIXME: replace with plugin from npmjs if possible
// Candidate [1] https://github.com/to-codando/esbuild-plugin-linter/issues/1
// Candidate [2] https://github.com/robinloeffel/esbuild-plugin-eslint/issues/5

import { ESLint } from 'eslint';

export const eslintPlugin = {
name: 'eslintPlugin',
setup(build) {
const filesToLint = [];
const eslint = new ESLint();
const filter = /src\/.*\.(jsx?|js?)$/;

build.onLoad({ filter }, ({ path }) => {
filesToLint.push(path);
});

build.onEnd(async () => {
const result = await eslint.lintFiles(filesToLint);
const formatter = await eslint.loadFormatter('stylish');
const output = formatter.format(result);
if (output.length > 0) {
// eslint-disable-next-line no-console
console.log(output);
}
});
},
}
2 changes: 1 addition & 1 deletion node_modules
Submodule node_modules updated 8168 files
48 changes: 16 additions & 32 deletions package.json
@@ -1,57 +1,39 @@
{
"name": "podman",
"description": "Cockpit UI for Podman Containers",
"type": "module",
"main": "index.js",
"repository": "git@github.com:cockpit-project/cockpit-podman.git",
"author": "",
"license": "LGPL-2.1",
"scripts": {
"watch": "webpack --watch --progress",
"build": "webpack",
"watch": "ESBUILD_WATCH='true' node build.js",
"build": "node build.js",
"eslint": "eslint --ext .jsx --ext .js src/",
"eslint:fix": "eslint --fix --ext .jsx --ext .js src/",
"stylelint": "stylelint src/*{.css,scss}",
"stylelint:fix": "stylelint --fix src/*{.css,scss}"
},
"devDependencies": {
"@babel/core": "^7.6.0",
"@babel/eslint-parser": "^7.13.14",
"@babel/preset-env": "7.12.17",
"@babel/preset-react": "^7.0.0",
"argparse": "^2.0.1",
"babel-loader": "^8.0.0",
"chrome-remote-interface": "^0.31.2",
"compression-webpack-plugin": "^6.0.0",
"copy-webpack-plugin": "^6.1.0",
"css-loader": "^5.2.0",
"css-minimizer-webpack-plugin": "4.0.0",
"eslint": "^7.10.0",
"eslint-config-standard": "^16.0.0",
"eslint-config-standard-jsx": "^10.0.0",
"eslint-config-standard-react": "^11.0.1",
"eslint-plugin-flowtype": "^5.2.0",
"eslint-plugin-import": "^2.22.1",
"eslint-plugin-jsx-a11y": "^6.5.1",
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-promise": "^5.1.0",
"eslint-plugin-react": "^7.23.0",
"eslint-plugin-react-hooks": "^4.1.2",
"eslint-plugin-standard": "^4.0.1",
"eslint-webpack-plugin": "^2.5.3",
"esbuild-plugin-copy": "^2.0.2",
"eslint": "^8.29.0",
"eslint-config-standard": "^17.0.0",
"eslint-config-standard-jsx": "^11.0.0",
"eslint-config-standard-react": "^13.0.0",
"eslint-plugin-flowtype": "^8.0.3",
"eslint-plugin-jsx-a11y": "^6.7.1",
"eslint-plugin-react": "^7.32.2",
"eslint-plugin-react-hooks": "^4.6.0",
"eslint-plugin-standard": "^5.0.0",
"gettext-parser": "^2.0.0",
"htmlparser": "^1.7.7",
"jed": "^1.1.1",
"mini-css-extract-plugin": "^0.11.0",
"sass": "^1.35.1",
"sass-loader": "^12.1.0",
"sizzle": "^2.3.3",
"string-replace-loader": "^3.0.0",
"stylelint": "^14.9.1",
"stylelint-config-standard-scss": "^5.0.0",
"stylelint-webpack-plugin": "^3.3.0",
"terser-webpack-plugin": "^5.1.3",
"webpack": "^5.31.0",
"webpack-cli": "^4.6.0"
"stylelint-config-standard-scss": "^5.0.0"
},
"dependencies": {
"@patternfly/patternfly": "4.224.2",
Expand All @@ -60,6 +42,8 @@
"@patternfly/react-table": "4.112.39",
"date-fns": "2.28.0",
"docker-names": "1.2.1",
"esbuild": "0.17.7",
"esbuild-sass-plugin": "2.4.5",
"prop-types": "15.8.1",
"react": "18.2.0",
"react-dom": "18.2.0",
Expand Down
2 changes: 1 addition & 1 deletion packaging/cockpit-podman.spec.in
Expand Up @@ -53,7 +53,7 @@ appstream-util validate-relax --nonet %{buildroot}/%{_datadir}/metainfo/*

%files
%doc README.md
%license LICENSE dist/index.js.LICENSE.txt.gz
%license LICENSE dist/index.js.LEGAL.txt dist/index.css.LEGAL.txt
%{_datadir}/cockpit/*
%{_datadir}/metainfo/*

Expand Down
162 changes: 0 additions & 162 deletions webpack.config.js

This file was deleted.

0 comments on commit d43945d

Please sign in to comment.