Skip to content

Commit

Permalink
feat: add types
Browse files Browse the repository at this point in the history
This compiles the project with `tsc` and publishes type declarations.

- All of `lib` is typed. some typing bugs were corrected
- types for `appium-adb` are stubbed, since that package also needs types
- `test` is untyped b/c it's a wreck
- removes babel
- upgrades eslint
- removes `pre-commit` for `husky`
  • Loading branch information
boneskull committed Feb 17, 2023
1 parent 17bd442 commit e4e2a82
Show file tree
Hide file tree
Showing 15 changed files with 759 additions and 390 deletions.
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
4 changes: 4 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* text=auto eol=lf

# Handle as a text file but merge as binary.
package-lock.json merge=binary
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npm run lint-staged
2 changes: 1 addition & 1 deletion .mocharc.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module.exports = {
require: ['@babel/register'],
require: ['ts-node/register'],
forbidOnly: Boolean(process.env.CI)
};
25 changes: 0 additions & 25 deletions babel.config.json

This file was deleted.

9 changes: 9 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,12 @@ import ChromedriverStorageClient from './lib/storage-client';

export { ChromedriverStorageClient };
export default chromedriver;

/**
* @typedef {import('./lib/types').ChromedriverOpts} ChromedriverOpts
* @typedef {import('./lib/types').ChromedriverDetails} ChromedriverDetails
* @typedef {import('./lib/types').ChromedriverVersionMapping} ChromedriverVersionMapping
* @typedef {import('./lib/types').ChromedriverStorageClientOpts} ChromedriverStorageClientOpts
* @typedef {import('./lib/types').SyncOptions} SyncOptions
* @typedef {import('./lib/types').OSInfo} OSInfo
*/
Loading

0 comments on commit e4e2a82

Please sign in to comment.