Prep testlab for publishing #219
Conversation
superkhau
changed the title
superkhau
force-pushed
the
prep-testlab-for-publishing
branch
3 times, most recently
from
3ade9b5
to
557063e
Compare
| ```js | ||
| const Application = require('@loopback/loopback').Application; | ||
| const app = new Application(); | ||
| ``` |
There was a problem hiding this comment.
Ignore this, I'm branching off another branch that has these files. Will disappear once I land #213 and rebase.
| server.bind('applications.myApp').to(app); | ||
| return new Client(server); | ||
| } | ||
| }); |
There was a problem hiding this comment.
These too -- they will be gone after rebase.
superkhau
force-pushed
the
prep-testlab-for-publishing
branch
4 times, most recently
from
92801b9
to
9621bf1
Compare
| const should = require('should'); | ||
| const testlab = require('..'); | ||
|
|
||
| describe('testlab', () => { |
There was a problem hiding this comment.
maybe we should not here that this is a JS smoke test - not a real test
There was a problem hiding this comment.
Well it's using the real compiled files, but yes a true test would have to require the dep from NPMJS (ie. add testlab as a true dep via npm install -S testlab). Renaming to smoke test for clarity.
| "clean": "rm *.tgz; rm -rf ./package", | ||
| "prepublish": "npm run build", | ||
| "test": "mocha", | ||
| "verify": "npm run clean && npm pack && tar xvzf *.tgz && tree package" |
There was a problem hiding this comment.
is this for local testing only? tree is only avail. via brew
There was a problem hiding this comment.
Yes, only for local testing to make sure the packaged contents are what we expect. tar is not available on Windows too, but this NPM script should be temporary. Will remove once we get more insight into final publishing routines.
superkhau
force-pushed
the
prep-testlab-for-publishing
branch
2 times, most recently
from
6eb3da1
to
5567a5f
Compare
- Add smoke test to ensure exported module works as expected
superkhau
force-pushed
the
prep-testlab-for-publishing
branch
from
5567a5f
to
652ee29
Compare
| package | ||
| src | ||
| test | ||
| tsconfig.json |
There was a problem hiding this comment.
I think we should be using an explicit white-list of files to include in the package via package.json files property, rather than maintaining a backlist in .npmignore.
There was a problem hiding this comment.
Note that the list of files can specify directories too, e.g.
"files": [
"index.js",
"index.d.ts",
"lib"
]
| "module": "commonjs", | ||
| "moduleResolution": "node", | ||
| "outDir": "./lib", | ||
| "strictNullChecks": true, |
There was a problem hiding this comment.
Please don't duplicate this configuration, inherit it from top-level tsconfig.json instead.
Ideally, the project-level tsconfig.json should configure only include and exclude, all compilerOptions should be inherited.
|
@superkhau I am afraid this build the type information when running I.e. when you |
See d41ee54 |
cc @bajtos @raymondfeng