-
Notifications
You must be signed in to change notification settings - Fork 5
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
Update README.md #16
base: develop
Are you sure you want to change the base?
Update README.md #16
Conversation
@@ -104,6 +104,7 @@ https://github.com/readium/r2-opds-js/blob/develop/src/opds/init-globals.ts | |||
```typescript | |||
// npm install r2-opds-js | |||
// "@opds" is a dist path alias, for example EcmaScript6/ES2015 'node_modules/r2-opds-js/dist/es6-es2015/src/opds/' | |||
// Tips!: see https://www.npmjs.com/package/tsconfig-paths to execute the compiled files with node |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When you say "the compiled files", do you actually mean the "uncompiled" / "non-transpiled" TS files?
Note that r2-opds-js
has a basic ts-node
setup for unit tests (via Ava). As you can see, we already use tsconfig-paths
:
Lines 72 to 73 in e410866
"ts-node": "^9.1.1", | |
"tsconfig-paths": "^3.9.0", |
Line 119 in e410866
"testTS": "cross-env DEBUG=r2:* TYPESCRIPT=1 ava", |
Lines 38 to 49 in e410866
if (ts) { | |
conf.environmentVariables = { | |
"TS_NODE_CACHE": "true", | |
"TS_NODE_CACHE_DIRECTORY": "./ava-ts/", | |
"TS_NODE_PRETTY": "true", | |
"TS_NODE_COMPILER_OPTIONS": "{\"typeRoots\" : [\"./node_modules/@types\", \"./test/@types\"]}" | |
}; | |
conf.require = [ | |
"ts-node/register", | |
"tsconfig-paths/register" | |
]; | |
} |
Same with r2-shared-js
:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you add it in the readme ? , whatever the way
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should all r2-xxx-js
repositories be updated? (i.e. r2-utils-js
, r2-lcp-js
, r2-shared-js
, r2-opds-js
, r2-streamer-js
, r2-navigator-js
, r2-testapp-js
)
No description provided.