Feature : Added markdown-toc package to auto-generate toc with husky pre commit hook. #1280

aialok · 2023-12-25T09:20:01Z

What kind of change does this PR introduce?

Added update-toc script to pre-commit hook
This commit adds the "update-toc" script to the pre-commit hook in the .husky/pre-commit file. This script updates the table of contents in the INSTALLATION.md file using the markdown-toc package.

Issue Number:

Fixes #1234

Did you add tests for your changes?

No

Snapshots/Videos:

Here is clip of how table of content is getting generated on committing the changes

cinnamon-2023-12-25T140007+0530.webm

If relevant, did you update the documentation?

No

Summary

Add markdown-toc package for generating table of contents
This commit adds the "markdown-toc" package to the project's dependencies in the package.json file. This package is used to generate a table of contents in the INSTALLATION.md file.

Does this PR introduce a breaking change?

No

Other information

Have you read the contributing guide?

Yes

…o automatically update TOC in INSTALLATION.md using markdown-toc package.

github-actions · 2023-12-25T09:20:32Z

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

The overall code coverage drops below the target threshold of the repository
Any file in the pull request has code coverage levels below the repository threshold
Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

comments in this PR or
our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

arbitrators of future discussions with other contributors about the validity of your changes
point of contact for evaluating the validity of your work
person who verifies matching issues by others that should be closed.
person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

PRs with issues not assigned to you will be closed by the reviewer
Fix the first comment in the PR so that each issue listed automatically closes

Other

🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
Read the CONTRIBUTING.md file make

palisadoes

This should be done for all the markdown files in the riot directory. That would solve a universal problem. Please update.

palisadoes · 2023-12-25T12:14:35Z

Please fix the failing typescript tests

aialok · 2023-12-25T17:45:24Z

Hey @palisadoes ! I have added a new update-toc.js file where it will execute markdown-toc -i "${file}" --bullets "-" for each .md file present in the talawa-admin.
Here is clip how it is working :

cinnamon-2023-12-25T224523+0530.webm

If it look good I will push the changes.

palisadoes · 2023-12-25T20:34:29Z

Yes, go ahead.
Please merge your code with the latest upstream

codecov · 2023-12-25T21:03:00Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (eab9e4d) 96.57% compared to head (d0fbd33) 96.57%.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #1280   +/-   ##
========================================
  Coverage    96.57%   96.57%           
========================================
  Files          137      137           
  Lines         3417     3417           
  Branches       958      958           
========================================
  Hits          3300     3300           
  Misses         112      112           
  Partials         5        5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

palisadoes

Why is this PR updating typescript and language JSON files?
Please don't include them in the PR. Do not delete them from the repo.

aialok · 2023-12-25T22:20:05Z

Why is this PR updating typescript and language JSON files?

Please don't include them in the PR. Do not delete them from the repo.

Those changes are not mine. It is there because I have fetched the latest upstream which is committed by other.

palisadoes · 2023-12-25T22:39:09Z

Though they may not be your edits, they must not be included in this PR. We only want to review what was required in the source issue

palisadoes

See comment

.husky/pre-commit

palisadoes

See comment

package.json

palisadoes · 2023-12-28T07:44:09Z

This solution doesn't use a script
It'll also be added to the Git hooks

Added script to generate table of content talawa-api#1587 (comment)

PTAL

palisadoes · 2023-12-28T07:58:56Z

Is this integrated with the git hooks?

aialok · 2023-12-28T08:00:27Z

Is this integrated with the git hooks?

Yes, I have added command in husky pre commit hook.

palisadoes · 2023-12-28T12:04:13Z

I thought about the universality of this solution. Will it work for developers running on the most OS platforms?

Windows
Mac
Linux

For example, the find command is Unix specific

aialok · 2023-12-28T13:47:14Z

I thought about the universality of this solution. Will it work for developers running on the most OS platforms?

Windows

Mac

Linux

For example, the find command is Unix specific

Hey, I try running in windows environment its not working as some of the UNIX command is not supported by Windows PowerShell and command prompt . Either we can add this to GitHub actions workflow and run this command. or we can roll back to node script which I wrote. I tried running node script in both windows and Linux and its working fine.
One more things which we can do is to write script for each platform.
Node Scripts

Bash Command

palisadoes · 2023-12-28T16:21:06Z

Create a typescript file and it to a scripts/githooks directory. It'll help with standardization
The scripts directory already exists.
Move any other git hooks scripts there too and update the hook for the new location

aialok · 2023-12-28T18:44:48Z

Create a typescript file and it to a scripts/githooks directory. It'll help with standardization

The scripts directory already exists.

Move any other git hooks scripts there too and update the hook for the new location

Can I use javascript file as other script for testing in js and if we are using js then we dont need to compile ts to js and then run it with node.
It will be easy for us to run the script.

palisadoes · 2023-12-28T18:45:54Z

Create a typescript file and it to a scripts/githooks directory. It'll help with standardization

The scripts directory already exists.

Move any other git hooks scripts there too and update the hook for the new location
* Can I use javascript file as other script for `testing` in js and if we are using js then we dont need to compile ts to js and then run it with node.

* It will be easy for us to run the script.

OK

aialok · 2023-12-29T08:13:48Z

@palisadoes , Please Have a look : )

Create a typescript file and it to a scripts/githooks directory. It'll help with standardization

The scripts directory already exists.

Move any other git hooks scripts there too and update the hook for the new location
* Can I use javascript file as other script for `testing` in js and if we are using js then we dont need to compile ts to js and then run it with node.

* It will be easy for us to run the script.
OK

@palisadoes , Please have a look : )

aialok · 2023-12-29T18:31:51Z

Hi @palisadoes , could you please check this out? Thanks!

Included "update-toc" script in pre-commit hook (.husky/pre-commit) t…

0e2b972

…o automatically update TOC in INSTALLATION.md using markdown-toc package.

palisadoes requested changes Dec 25, 2023

View reviewed changes

Added auto-toc of content update-toc to update all markdown file toc

0aad977

aialok force-pushed the installationdotmd-new-toc branch from 81db5f7 to 0aad977 Compare December 26, 2023 07:53

palisadoes requested changes Dec 27, 2023

View reviewed changes

.husky/pre-commit Outdated Show resolved Hide resolved

aialok requested review from palisadoes December 27, 2023 19:26

palisadoes requested changes Dec 27, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

moved update-toc.js to scritp directory

e7c4ff0

palisadoes mentioned this pull request Dec 28, 2023

Added script to generate table of content PalisadoesFoundation/talawa-api#1587

Merged

added update-toc file to script/githooks for auto-toc generation

aafa094

aialok force-pushed the installationdotmd-new-toc branch from abccb88 to aafa094 Compare December 28, 2023 18:52

Merge branch 'develop' into installationdotmd-new-toc

d0fbd33

palisadoes approved these changes Dec 29, 2023

View reviewed changes

palisadoes merged commit d15cf33 into PalisadoesFoundation:develop Dec 29, 2023
8 of 9 checks passed

palisadoes mentioned this pull request Dec 30, 2023

Table of content PalisadoesFoundation/talawa-api#1598

Closed

aialok mentioned this pull request Jan 2, 2024

Feature: Social Icons Integration on Login and Signup Page #1326

Merged

aialok deleted the installationdotmd-new-toc branch January 7, 2024 12:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature : Added markdown-toc package to auto-generate toc with husky pre commit hook. #1280

Feature : Added markdown-toc package to auto-generate toc with husky pre commit hook. #1280

aialok commented Dec 25, 2023

github-actions bot commented Dec 25, 2023

palisadoes left a comment

palisadoes commented Dec 25, 2023

aialok commented Dec 25, 2023

palisadoes commented Dec 25, 2023

codecov bot commented Dec 25, 2023 •

edited

Loading

palisadoes left a comment •

edited

Loading

aialok commented Dec 25, 2023 •

edited

Loading

palisadoes commented Dec 25, 2023

palisadoes left a comment

palisadoes left a comment

palisadoes commented Dec 28, 2023

palisadoes commented Dec 28, 2023

aialok commented Dec 28, 2023 •

edited

Loading

palisadoes commented Dec 28, 2023

aialok commented Dec 28, 2023

palisadoes commented Dec 28, 2023

aialok commented Dec 28, 2023

palisadoes commented Dec 28, 2023

aialok commented Dec 29, 2023

aialok commented Dec 29, 2023

Feature : Added markdown-toc package to auto-generate toc with husky pre commit hook. #1280

Feature : Added markdown-toc package to auto-generate toc with husky pre commit hook. #1280

Conversation

aialok commented Dec 25, 2023

github-actions bot commented Dec 25, 2023

Our Pull Request Approval Process

Testing Your Code

Reviewers

Reviewing Your Code

CONTRIBUTING.md

Other

palisadoes left a comment

Choose a reason for hiding this comment

palisadoes commented Dec 25, 2023

aialok commented Dec 25, 2023

palisadoes commented Dec 25, 2023

codecov bot commented Dec 25, 2023 • edited Loading

Codecov Report

palisadoes left a comment • edited Loading

Choose a reason for hiding this comment

aialok commented Dec 25, 2023 • edited Loading

palisadoes commented Dec 25, 2023

palisadoes left a comment

Choose a reason for hiding this comment

palisadoes left a comment

Choose a reason for hiding this comment

palisadoes commented Dec 28, 2023

palisadoes commented Dec 28, 2023

aialok commented Dec 28, 2023 • edited Loading

palisadoes commented Dec 28, 2023

aialok commented Dec 28, 2023

palisadoes commented Dec 28, 2023

aialok commented Dec 28, 2023

palisadoes commented Dec 28, 2023

aialok commented Dec 29, 2023

aialok commented Dec 29, 2023

codecov bot commented Dec 25, 2023 •

edited

Loading

palisadoes left a comment •

edited

Loading

aialok commented Dec 25, 2023 •

edited

Loading

aialok commented Dec 28, 2023 •

edited

Loading