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 readme for running js-slang without adding to PATH #1716

Merged
merged 2 commits into from
Sep 8, 2024

Conversation

heyzec
Copy link
Contributor

@heyzec heyzec commented Sep 7, 2024

Description

Following instructions on README for running the REPL without adding js-slang to PATH does not work as the command node dist/repl/repl.js quits immediately. This was due to #1672 refactored runner execution and changed the entry point to the REPL from src/repl/repl.ts to src/repl/index.ts.

This is a minor issue since anyone who follows the documentation to link js-slang to PATH using npm link will not be affected by the readme bug.

Type of change

  • 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 not work as expected)
  • Documentation update
  • Code quality improvements

How to test

Checklist

  • I have tested this code
  • I have updated the documentation

@heyzec heyzec changed the title Fix readme for adding js-slang to PATH Fix readme for running js-slang without adding to PATH Sep 7, 2024
Copy link
Member

@RichDom2185 RichDom2185 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! (Sorry I forgot you use rebase instead of merge 😂)

@RichDom2185 RichDom2185 enabled auto-merge (squash) September 8, 2024 04:09
@RichDom2185 RichDom2185 merged commit 82d6eea into source-academy:master Sep 8, 2024
1 check passed
@coveralls
Copy link

coveralls commented Sep 8, 2024

Pull Request Test Coverage Report for Build 10749362118

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 81.524%

Totals Coverage Status
Change from base Build 10688058649: 0.0%
Covered Lines: 10921
Relevant Lines: 13029

💛 - Coveralls

@heyzec heyzec deleted the readme-repl branch October 7, 2024 11:59
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