Custom linters fail to load because @ruby/prism isn't installed

[asilano]

We have some custom linters defined (which have previously worked properly). When running the linter, I now get errors:

> npx @herb-tools/linter@latest
✓ Using Herb config file at /Users/asilano/project/.herb.yml
Error loading rule file "/Users/asilano/project/.herb/rules/erb_deprecated_form_builder.mjs": Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@ruby/prism' imported from /Users/asilano/project/node_modules/@herb-tools/linter/dist/index.js

I see that @ruby/prism is only a devDependency of @herb-tools/core, so it hasn't been installed along with Herb.

Question:
Should @ruby/prism be a full dependency of Herb, or should the docs be updated to note that it needs to be added to a project's packages if custom linters are defined?

[andyw8]

I ran into this too. #1806

[asilano]

Yep, that would be the fix. I just wanted to see if Marco wanted to do that, or preferred to leave it with the custom linters having to import explicitly.

[marcoroth]

Sorry for the lack of response here, I needed to step away a bit from the project to focus on other things.

We configured the core package to re-export the definitions from @ruby/prism here:

herb/javascript/packages/core/src/prism/index.ts

Lines 4 to 6 in c418987

	import type * as PrismNodeTypes from "@ruby/prism/src/nodes.js"
	export * as PrismNodes from "@ruby/prism/src/nodes.js"

Maybe I ask what kind of imports you need?

[asilano]

Sorry for the lack of response here, I needed to step away a bit from the project to focus on other things.

No worries 👍

Maybe I ask what kind of imports you need?

I don't know. I'm not importing anything specific from prism, just from @herb-tools/linter. For instance, I have a rule which starts with:

import { BaseRuleVisitor, ParserRule } from "@herb-tools/linter";

purely so that I can extend from those classes to make a Rule and a Visitor that performs the lint check.

If I remove that line, and replace it with stubbed code so the file is still syntactically valid:

// import { BaseRuleVisitor, ParserRule } from "@herb-tools/linter";

class BaseRuleVisitor {}
class ParserRule {}

...then the custom rule successfully loads. Of course, it doesn't work (Error: TypeError: visitor.visit is not a function), but it does load without error.

(I've not put the actual linter content because it seems irrelevant; it's the import line that causes problems. I can supply the linter in total if needed)

[marcoroth]

Oh I see, I misunderstood then.

This is definitely broken then and not intentional. I'm going to check if #1806 fixes this. Thanks!