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

Fix links to source code in README #525

Merged
merged 2 commits into from
Apr 12, 2022
Merged

Fix links to source code in README #525

merged 2 commits into from
Apr 12, 2022

Conversation

MichaelGoberling
Copy link
Contributor

Modified README to change file extensions in links to source code from .ts to .js.

Related Issue

Motivation and Context

This change is required so that links to source files will work.

How Has This Been Tested?

Manually tested via personal fork of repository.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@codecov
Copy link

codecov bot commented Apr 11, 2022

Codecov Report

Merging #525 (ae1818d) into master (7f985a2) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #525   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           50        50           
  Lines         2600      2600           
  Branches       472       472           
=========================================
  Hits          2600      2600           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7f985a2...ae1818d. Read the comment docs.

Copy link
Contributor

@sandeep-paliwal sandeep-paliwal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@shazron shazron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, the README is auto-generated by the npm script prepack in package.json, right before packing for publishing to npm. (run it via npm run prepack).

The actual error we need to investigate is why oclif thinks our source files are Typescript.

@shazron
Copy link
Member

shazron commented Apr 12, 2022

The fix would be to remove this devDependency:

"typescript": "^4.5.2"

@MichaelGoberling
Copy link
Contributor Author

Typescript dependency removed from package.json and confirmed that running npm run prepack will generate code links with .js extensions now.

@purplecabbage purplecabbage merged commit 7a32a8f into adobe:master Apr 12, 2022
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.

4 participants