chore / CLOUD-25080 / check presence of file headers #22
Conversation
oli-hivemq
commented
Aug 27, 2024
•
oli-hivemq
commented
- add a check-header script for verifying that all code files start with the right header
- add github workflows:
- unit tests
- linting
- check presence of headers with copyright in all files
oli-hivemq
force-pushed
the
chore/CLOUD-25080/add-copyright-license-headers
branch
from
984ee90
to
f87770c
Compare
| const __filename = fileURLToPath(import.meta.url) | ||
| const __dirname = path.dirname(__filename) | ||
|
|
||
| const regexToIgnore = [ |
There was a problem hiding this comment.
How do we check its completeness?
For example, a YAML file could be in the code and, supporting comments, could have it's header
There was a problem hiding this comment.
I was wondering what should be considered code to be honest. I assumed YAML files were probably not important, tsconfig and vite config files either. Well you've seen the list.
But that's a good question and if you feel like any of the files ignored should have their headers, let me know which ones you'd consider as code and I'll add headers.
There was a problem hiding this comment.
I'd say configuration files yaml, json, toml, or any dotfile should not have the header since some do not event support comments in the first place.
There was a problem hiding this comment.
This look great, just one suggestion regarding the dotfiles, something like this might be more appropriate to match cases where the dotfile might be in a folder.
/(^|\/)\.[^/]*(?:\/[^/]*)*$/
|
Nice Job Oli! |
… for verifying that all code files start with the right header
oli-hivemq
force-pushed
the
chore/CLOUD-25080/add-copyright-license-headers
branch
from
1ac60ee
to
15b6919
Compare
| const __filename = fileURLToPath(import.meta.url) | ||
| const __dirname = path.dirname(__filename) | ||
|
|
||
| const regexToIgnore = [ |
There was a problem hiding this comment.
This look great, just one suggestion regarding the dotfiles, something like this might be more appropriate to match cases where the dotfile might be in a folder.
/(^|\/)\.[^/]*(?:\/[^/]*)*$/
