search

mikaelvesavuori / figmagic

Figmagic is the missing piece between DevOps and design: Generate design tokens, export graphics, and extract design token-driven React components from your Figma documents.
https://docs.figmagic.com
MIT License
813 stars 73 forks source link

Remove docs command from pre-commit hook #135

Closed opauloh closed 3 years ago

opauloh commented 3 years ago

Hey,

When attempting to commit I noticed it runs npm run docs, but I also noticed that it changes the href path of all links to the forked repository instead of keeping with the upstream branch.

image

I also tried to update typedoc.json to add 

"gitRemote": "upstream"

or 

"gitRemote": "https://github.com/mikaelvesavuori/figmagic.git"

as suggested in the docs, but then it removes the link to the upstream branch, keeping only the text:

image

So, if we still want the links to the files, I think we can remove the docs generation as a pre-commit hook, and let the maintainer generate. Another option is to edit typedoc.json to add gitRemote and lose the links in favour of improving maintenance.

mikaelvesavuori commented 3 years ago

Makes sense. I will need to add the doc generation task to the CI when I get time!

Merging.

sonarcloud[bot] commented 3 years ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information