Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(docs): run doctoc on pre-commit #399

Merged
merged 1 commit into from
Dec 29, 2019

Conversation

agilgur5
Copy link
Collaborator

@agilgur5 agilgur5 commented Dec 27, 2019

  • and install it as a devDep

  • doctoc is used in the README ToC and listed in comment, but wasn't
    a devDep or used in any internal scripts

Follow-up to #397 . Please merge after that one and after #398 , which I split out from this PR.

The big thing that's not so helpful about running doctoc on pre-commit as that it won't abort the commit if changes were made. It just adds new changes, but those haven't been staged yet so won't be included in the commit (unless you amend them in). Not sure what a better method may be that isn't overly complex 😕

- and install it as a devDep

- doctoc is used in the README ToC and listed in comment, but wasn't
  a devDep or used in any internal scripts
@swyxio
Copy link
Collaborator

swyxio commented Dec 28, 2019

how bout doing this via github action?

@jaredpalmer jaredpalmer merged commit f338613 into jaredpalmer:master Dec 29, 2019
@agilgur5
Copy link
Collaborator Author

agilgur5 commented Dec 31, 2019

ah so looks like this is a known issue of doctoc: thlorenz/doctoc#169, thlorenz/doctoc#161 . Could use that PR branch and run it with the code --stdout code listed which would be ideal

But, in general, doctoc isn't really maintained, so it might just make sense to look for an alternative instead of hacking around with it.


re: GitHub Action -- a GH Action wouldn't prevent errors like those in #307 from getting in, it would just fix them with an additional commit after; better to nip it in the bud beforehand imo.

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.

3 participants