Skip to content

A local-first personal finance app

Use Peggy instead of deprecated Peg.js (#934)

Davis Silvermanb0c5a9389c6f
diff --git a/packages/loot-core/jest.config.js b/packages/loot-core/jest.config.js
index 9078246af7..1a8248b709 100644
--- a/packages/loot-core/jest.config.js
+++ b/packages/loot-core/jest.config.js
@@ -20,6 +20,6 @@ module.exports = {
],
transformIgnorePatterns: ['/node_modules/'],
transform: {
- '\\.pegjs$': 'pegjs-jest-transformer',
+ '\\.pegjs$': '<rootDir>/peg-transform.mjs',
},
};
diff --git a/packages/loot-core/jest.web.config.js b/packages/loot-core/jest.web.config.js
index c974dab2b2..6158444fcf 100644
--- a/packages/loot-core/jest.web.config.js
+++ b/packages/loot-core/jest.web.config.js
@@ -17,6 +17,6 @@ module.exports = {
testMatch: ['**/*.web.test.(js|ts|tsx)'],
transformIgnorePatterns: ['/node_modules/(?!absurd-sql)'],
transform: {
- '\\.pegjs$': 'pegjs-jest-transformer',
+ '\\.pegjs$': '<rootDir>/peg-transform.mjs',
},
};
diff --git a/packages/loot-core/package.json b/packages/loot-core/package.json
index 36e6d6543e..9ef7ac840b 100644
--- a/packages/loot-core/package.json
+++ b/packages/loot-core/package.json
@@ -61,9 +61,7 @@
"mockdate": "^3.0.5",
"murmurhash": "^0.0.2",
"npm-run-all": "^4.1.3",
- "pegjs": "^0.10.0",
- "pegjs-jest-transformer": "^1.2.3",
- "pegjs-loader": "^0.5.6",
+ "peggy": "3.0.2",
"snapshot-diff": "^0.10.0",
"source-map": "^0.7.3",
"throttleit": "^1.0.0",
diff --git a/packages/loot-core/peg-loader.js b/packages/loot-core/peg-loader.js
new file mode 100644
index 0000000000..fdefafdd9f
--- /dev/null
+++ b/packages/loot-core/peg-loader.js
@@ -0,0 +1,9 @@
+// webpack loader for .pegjs files using Peggy.
+
+const peg = require('peggy');
+
+module.exports = function loadPeg(source) {
+ // TODO: a second value can be returned. A JS SourceMap object.
+ // Peggy can output such an object.
+ return peg.generate(source, { output: 'source', format: 'umd' });
+};
diff --git a/packages/loot-core/peg-transform.mjs b/packages/loot-core/peg-transform.mjs
new file mode 100644
index 0000000000..b5f1f1e798
--- /dev/null
+++ b/packages/loot-core/peg-transform.mjs
@@ -0,0 +1,24 @@
+// A peggy version of the pegjs-jest-transformer
+// Transforms .pegjs compliant files to JS code.
+
+import * as crypto from 'crypto';
+
+import peg from 'peggy';
+
+const transform = {
+ process(sourceText, sourcePath, _options) {
+ return `module.exports = ${peg.generate(sourceText, {
+ output: 'source-with-inline-map',
+ grammarSource: sourcePath,
+ })}`;
+ },
+ getCacheKey(sourceText, _sourcePath, options) {
+ return crypto
+ .createHash('md5')
+ .update(sourceText)
+ .update(options.configString)
+ .digest('hex');
+ },
+};
+
+export default transform;
diff --git a/packages/loot-core/src/server/budget/goal-template.pegjs b/packages/loot-core/src/server/budget/goal-template.pegjs
index b54b3d31c7..ab365d6200 100644
--- a/packages/loot-core/src/server/budget/goal-template.pegjs
+++ b/packages/loot-core/src/server/budget/goal-template.pegjs
@@ -1,4 +1,4 @@
-// https://pegjs.org
+// https://peggyjs.org
expr
= percent: percent _ of _ category: $([^\r\n\t]+)
diff --git a/packages/loot-core/webpack/webpack.browser.config.js b/packages/loot-core/webpack/webpack.browser.config.js
index e778806aa5..c30427f3b7 100644
--- a/packages/loot-core/webpack/webpack.browser.config.js
+++ b/packages/loot-core/webpack/webpack.browser.config.js
@@ -28,11 +28,6 @@ module.exports = {
path: 'path-browserify',
},
},
- resolveLoader: {
- alias: {
- 'pegjs-loader': require.resolve('pegjs-loader'),
- },
- },
module: {
rules: [
{
@@ -46,7 +41,7 @@ module.exports = {
},
{
test: /\.pegjs$/,
- use: { loader: 'pegjs-loader' },
+ use: { loader: path.resolve('../peg-loader.js') },
},
],
},
diff --git a/upcoming-release-notes/934.md b/upcoming-release-notes/934.md
new file mode 100644
index 0000000000..bdde27a0d5
--- /dev/null
+++ b/upcoming-release-notes/934.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [Sinistersnare]
+---
+
+Move from deprecated peg.js to Peggy for Goal template parser.
diff --git a/yarn.lock b/yarn.lock
index f15ab08ae9..0815186f7a 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -5709,13 +5709,6 @@ __metadata:
languageName: node
linkType: hard
-"big.js@npm:^3.1.3":
- version: 3.2.0
- resolution: "big.js@npm:3.2.0"
- checksum: 299449e40555625a308f01d74378677036b2ec98b30aaa89794b3afbd4eaa104b7456a989affadfd7f630dc14b3f1df250de9bddc4a6fc664e60727887bb33e7
- languageName: node
- linkType: hard
-
"big.js@npm:^5.2.2":
version: 5.2.2
resolution: "big.js@npm:5.2.2"
@@ -6760,6 +6753,13 @@ __metadata:
languageName: node
linkType: hard
+"commander@npm:^10.0.0":
+ version: 10.0.1
+ resolution: "commander@npm:10.0.1"
+ checksum: 436901d64a818295803c1996cd856621a74f30b9f9e28a588e726b2b1670665bccd7c1a77007ebf328729f0139838a88a19265858a0fa7a8728c4656796db948
+ languageName: node
+ linkType: hard
+
"commander@npm:^2.20.0":
version: 2.20.3
resolution: "commander@npm:2.20.3"
@@ -8540,13 +8540,6 @@ __metadata:
languageName: node
linkType: hard
-"emojis-list@npm:^2.0.0":
- version: 2.1.0
- resolution: "emojis-list@npm:2.1.0"
- checksum: fb61fa6356dfcc9fbe6db8e334c29da365a34d3d82a915cb59621883d3023d804fd5edad5acd42b8eec016936e81d3b38e2faf921b32e073758374253afe1272
- languageName: node
- linkType: hard
-
"emojis-list@npm:^3.0.0":
version: 3.0.0
resolution: "emojis-list@npm:3.0.0"
@@ -12963,15 +12956,6 @@ __metadata:
languageName: node
linkType: hard
-"json5@npm:^0.5.0":
- version: 0.5.1
- resolution: "json5@npm:0.5.1"
- bin:
- json5: lib/cli.js
- checksum: 9b85bf06955b23eaa4b7328aa8892e3887e81ca731dd27af04a5f5f1458fbc5e1de57a24442e3272f8a888dd1abe1cb68eb693324035f6b3aeba4fcab7667d62
- languageName: node
- linkType: hard
-
"json5@npm:^1.0.1":
version: 1.0.1
resolution: "json5@npm:1.0.1"
@@ -13249,18 +13233,6 @@ __metadata:
languageName: node
linkType: hard
-"loader-utils@npm:^0.2.5":
- version: 0.2.17
- resolution: "loader-utils@npm:0.2.17"
- dependencies:
- big.js: ^3.1.3
- emojis-list: ^2.0.0
- json5: ^0.5.0
- object-assign: ^4.0.1
- checksum: 3045c83ef8b19d66d4c25e3245120c579883f473fe0d0559552f55502be913725c4d558a7c866191a74b19ef2af20b094afe3b144ae1e717ea4c245d52f60a09
- languageName: node
- linkType: hard
-
"loader-utils@npm:^1.2.3, loader-utils@npm:^1.4.0":
version: 1.4.0
resolution: "loader-utils@npm:1.4.0"
@@ -13465,9 +13437,7 @@ __metadata:
node-fetch: ^2.6.9
node-libofx: "*"
npm-run-all: ^4.1.3
- pegjs: ^0.10.0
- pegjs-jest-transformer: ^1.2.3
- pegjs-loader: ^0.5.6
+ peggy: 3.0.2
snapshot-diff: ^0.10.0
source-map: ^0.7.3
throttleit: ^1.0.0
@@ -14689,7 +14659,7 @@ __metadata:
languageName: node
linkType: hard
-"object-assign@npm:^4.0.1, object-assign@npm:^4.1.0, object-assign@npm:^4.1.1":
+"object-assign@npm:^4.1.0, object-assign@npm:^4.1.1":
version: 4.1.1
resolution: "object-assign@npm:4.1.1"
checksum: fcc6e4ea8c7fe48abfbb552578b1c53e0d194086e2e6bbbf59e0a536381a292f39943c6e9628af05b5528aa5e3318bb30d6b2e53cadaf5b8fe9e12c4b69af23f
@@ -15352,36 +15322,15 @@ __metadata:
languageName: node
linkType: hard
-"pegjs-jest-transformer@npm:^1.2.3":
- version: 1.2.3
- resolution: "pegjs-jest-transformer@npm:1.2.3"
- dependencies:
- typescript: ">=4.5 <5.0"
- peerDependencies:
- jest: ^29.0.0
- pegjs: ^0.10.0
- checksum: 2af4d48e6162fda8a0ed98b8c02780727e0528dee5af5c6dd1261945d155943f55cd7e58791419991b88759bb9d89e57e0fec5ec96177cef0e24bd508b6b0eae
- languageName: node
- linkType: hard
-
-"pegjs-loader@npm:^0.5.6":
- version: 0.5.6
- resolution: "pegjs-loader@npm:0.5.6"
+"peggy@npm:3.0.2":
+ version: 3.0.2
+ resolution: "peggy@npm:3.0.2"
dependencies:
- loader-utils: ^0.2.5
- peerDependencies:
- pegjs: ^0.10.0
- webpack: ">=1"
- checksum: 26f7a1a49c05cc61bb619e0158da18416e3574729be4fda4af366000f0a264743b692f87273415f73651c9bf20b9306e43822b7a7053103a1fdeca27cead003d
- languageName: node
- linkType: hard
-
-"pegjs@npm:^0.10.0":
- version: 0.10.0
- resolution: "pegjs@npm:0.10.0"
+ commander: ^10.0.0
+ source-map-generator: 0.8.0
bin:
- pegjs: bin/pegjs
- checksum: 65d184ca0e1823ec0a3e7f384d7fd771bcbbc7abf460c82c9704022c1fa325425dc9007c92982b951879c3c9d4c39bf5cd6d99690e0540ff5016c04ca1ecd17e
+ peggy: bin/peggy.js
+ checksum: bdca2291a2453e35fb9499bd414f25d44093aecaeb992ef90151ab126514c053c30d4bf5b54f68cbce22a4420eef75219a6deb1209b300630bff38e7640115d9
languageName: node
linkType: hard
@@ -18395,6 +18344,13 @@ __metadata:
languageName: node
linkType: hard
+"source-map-generator@npm:0.8.0":
+ version: 0.8.0
+ resolution: "source-map-generator@npm:0.8.0"
+ checksum: 15e7854c04a4b1bc8a477664a65c58316d792fb24a7b427219ac597eed7f57a3905637c783126b123cf05f9d4fdc45a8fadb8bc2fbf010a82d92e35c193aba51
+ languageName: node
+ linkType: hard
+
"source-map-js@npm:^1.0.1, source-map-js@npm:^1.0.2":
version: 1.0.2
resolution: "source-map-js@npm:1.0.2"
@@ -19777,7 +19733,7 @@ __metadata:
languageName: node
linkType: hard
-"typescript@npm:>=4.5 <5.0, typescript@npm:^4.6.4":
+"typescript@npm:^4.6.4":
version: 4.9.4
resolution: "typescript@npm:4.9.4"
bin:
@@ -19797,7 +19753,7 @@ __metadata:
languageName: node
linkType: hard
-"typescript@patch:typescript@>=4.5 <5.0#~builtin<compat/typescript>, typescript@patch:typescript@^4.6.4#~builtin<compat/typescript>":
+"typescript@patch:typescript@^4.6.4#~builtin<compat/typescript>":
version: 4.9.4
resolution: "typescript@patch:typescript@npm%3A4.9.4#~builtin<compat/typescript>::version=4.9.4&hash=23ec76"
bin: