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.

Sign up for GitHub

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

feat: allow using streetmerchant as a library #2038

Closed
wants to merge 5 commits into from
Closed

feat: allow using streetmerchant as a library #2038

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5cb95b4
feat: allow using streetmerchant in another yarn project
Feb 26, 2021
bc770ec
feat: expose the version number as part of the npm package
Feb 26, 2021
a2f145e
chore: bump support for recent node engines
Feb 26, 2021
606c9ed
Merge branch 'main' into gm/packaging
jef Mar 2, 2021
9449481
Merge branch 'main' into gm/packaging
jef Mar 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "streetmerchant",
"version": "3.4.1",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding a version number here will increase the maintenance burden because it requires updating versions in two places. I can change banner.ts to use this number if that's preferable.

The changes in this file aren't strictly necessary as it's easy to make them myself and then tell git to make them assume-unchanged.

Copy link
Owner

Choose a reason for hiding this comment

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

Before we make this change, I'd like to update the pipeline to manage this for us. This is easy enough, but just needs an update.

"description": "The world's easiest, most powerful stock checker",
"main": "src/index.ts",
"scripts": {
Expand All @@ -17,7 +18,7 @@
"test:notification:production": "node build/test/functional/test-notification.js"
},
"engines": {
"node": ">=12.0.0 <15.0.0"
"node": ">=12.0.0 <15.11.0"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I understand that there could be good reasons for keeping <15.0.0, which I don't know.

Copy link
Owner

Choose a reason for hiding this comment

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

I was keep it below 15 only because some folks were having problems with tsc. We should probably get on latest sooner than later though!

},
"repository": {
"type": "git",
Expand Down
3 changes: 2 additions & 1 deletion src/banner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import chalk from 'chalk';
import {readFileSync} from 'fs';
import path from 'path';

const version = readFileSync('version.txt', 'utf8');
const version = readFileSync(path.join(__dirname, '../../version.txt'), 'utf8');
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would really like to get this change in if possible. I'm not terribly familiar with the typescript compiler nor the node runner, but when I run it from my other project, the version.txt file isn't found as it's looking for it somewhere else.

Copy link
Owner

Choose a reason for hiding this comment

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

Interesting... Yeah I'm getting the version running as is, but if you're running within Docker, this could be an issue?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it was looking in the path of the project that wraps it.


export const banner = {
asciiVersion: `
Expand Down