removed ruby/gem dependencies in env.ps1 and updated the docs, added markdownlint-hook.ps1, docs.ps1, and docker.ps1 #636
Conversation
script/env.ps1
Outdated
| # Install markdownlint | ||
| gem install mdl | ||
| choco install markdownlint-cli |
There was a problem hiding this comment.
The markdownlint-cli package is related to markdownlint by David Anson. This package is good but is different from the markdownlint package used by codeclimate. So unfortunately we have to keep the mdl installation.
There was a problem hiding this comment.
The markdownlint-cli package is related to markdownlint by David Anson. This package is good but is different from the markdownlint package used by codeclimate. So unfortunately we have to keep the
mdlinstallation.
Oh okay, so should i revoke the changes and make it like it was before with the ruby and gem install?
script/markdownlint-hook.ps1
Outdated
| # This script is used by the pre-commit hook to check the markdown files without exiting the commit process. | ||
|
|
||
| # Invoke markdownlint and capture the output | ||
| $output = markdownlint $args |
There was a problem hiding this comment.
There is a mistake in the existing bash script. Even though we are installing mdl, the script uses markdownlint. We need to use mdl here.
The mdl has pre-commit hooks available. We couldn't find a way to leave a warning message for a check of pre-commit. So the markdown check has been moved to a script to turn errors into warnings. It is advantageous to use a python script (named mdl-check.py) to run the mdl command to make the script cross-platform.
There was a problem hiding this comment.
There is a mistake in the existing bash script. Even though we are installing
mdl, the script usesmarkdownlint. We need to usemdlhere. Themdlhas pre-commit hooks available. We couldn't find a way to leave a warning message for a check of pre-commit. So the markdown check has been moved to a script to turn errors into warnings. It is advantageous to use a python script (namedmdl-check.py) to run themdlcommand to make the script cross-platform.
okay got it
script/docs.ps1
Outdated
There was a problem hiding this comment.
please update the instructions in docs/PUBLISH.md as well
|
Sir could you give me a brief of what all changes I need to revoke and the ones that I need to add |
@aryanbhosale The list of changes required are:
|
…lint-hooks for crossplatform, added mdl-check.py
![codeclimate[bot]](https://avatars.githubusercontent.com/in/9403?s=60&v=4){kind=small}
| @@ -57,7 +57,7 @@ scripts. | |||
| 1. Install Ruby from | |||
| [official Ruby website](https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.1.2-1/rubyinstaller-devkit-3.1.2-1-x64.exe) | |||
| and follow all the defaults during the installation. | |||
|
|
|||
|
Code Climate has analyzed commit f460288 and detected 4 issues on this pull request. Here's the issue category breakdown:
View more on Code Climate. |
| import subprocess | ||
| import sys | ||
|
|
||
| def markdownlint_hooks(files): |
There was a problem hiding this comment.
Is there an advantage to having two separate python programs? Can the mdl command be executed in this function?
|
|
||
| # Generate and publish documents | ||
| Write-Output "Generate and publish documents..." | ||
| & mkdocs build --config-file mkdocs.yml --site-dir "site/online/$Version" |
There was a problem hiding this comment.
is the mkdocs build and serve problem with weasyprint solved?
No description provided.