Skip to content

Conversation

@vbakke
Copy link
Collaborator

@vbakke vbakke commented Jan 17, 2026

As long as we have two copies of the README.md file, there is a chance of misalignment.

This PR adds a npm prebuild step, which copies the root ./README.md to src/assets/Markdown Files/README.md when building.

It also adds a warning to the top of the assets readme file, To point developers in the right direction if they open the wrong readme.

If the assets readme is newer than the root readme, the step copies it assets version to a README.md.bak and outputs a warning.

@vbakke
Copy link
Collaborator Author

vbakke commented Jan 17, 2026

One issue is that the copy-readme.js runs on node (i.e. not typescript), and fails the current eslint setup in the workflow. (Running npm lint locally yields no error.)

According to the ever so wise Claude, we should change ESLint.yaml
from: run: yarn run eslint . --ext .js,.jsx,.ts,.tsx
to run: yarn run lint


Cross check with Claude:

So what is the consequences of removing the --ext .js,.jsx,.ts,.tsx in this project?

The answer:

Searched the text and files in this project
Perfect! Here's what removing the --ext .js,.jsx,.ts,.tsx flag means:

No negative consequences for this project. Here's why:

  1. Your local lint script uses Angular CLI: ng lint is configured in [angular.json:109-115] to only lint:

src/\*\*/*.ts
src/\*\*/*.html

  1. The .js files are ignored anyway: Your project has 2 JavaScript files:
  • karma.conf.js - test config
  • copy-readme.js - build script

Neither are in the src directory, so they're not linted by ng lint.

  1. The old workflow command was actually wrong: It was trying to lint .js and .jsx files that either don't exist or aren't configured in your ESLint config, causing the error.

Result: The GitHub workflow now matches your local setup exactly. Both lint only TypeScript and HTML files in the src folder, which is what your ESLint configuration supports.


I'm not able to test this properly in my repo. So let's have a chat, @wurstbrot. But, first we need to decide whether we actually want two README files or not (ref slack) I just filed this a s DRAFT pull request, so that we have it for later :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant