Skip to content

Commit

Permalink
chore: cleanup, updates
Browse files Browse the repository at this point in the history
  • Loading branch information
zacanger committed Jan 1, 2024
1 parent 5f5f034 commit b3f60a1
Show file tree
Hide file tree
Showing 931 changed files with 10,292 additions and 221,789 deletions.
15 changes: 15 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
module.exports = {
overrides: [
{
files: ['src/*.ts'],
extends: 'standard-with-typescript',
rules: {
'array-bracket-spacing': [ 'error', 'always' ],
'@typescript-eslint/no-confusing-void-expression': 'off',
'comma-dangle': 'off',
'@typescript-eslint/comma-dangle': [ 'error', 'always-multiline' ],
'@typescript-eslint/strict-boolean-expressions': 'off',
},
},
],
}
File renamed without changes.
5 changes: 2 additions & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,5 @@ jobs:
uses: actions/setup-node@v1
with:
node-version: 21.x
- run: echo 'disabled for now'
# - run: npm ci
# - run: npm t
- run: npm ci
- run: npm t
20 changes: 3 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Node utility library.
* [Documentation](https://zacanger.github.io/zeelib)
* [npm](https://npmjs.com/package/zeelib)
* [Changes](./CHANGELOG.md)
* [Contributing](./CONTRIBUTING.md)
* [Contributing](./.github/CONTRIBUTING.md)
* [License (MIT)](./LICENSE.md)

[![npm version](https://img.shields.io/npm/v/zeelib.svg)](https://npm.im/zeelib) [![ko-fi](https://img.shields.io/badge/donate-KoFi-yellow.svg)](https://ko-fi.com/U7U2110VB) [![Support with PayPal](https://img.shields.io/badge/paypal-donate-yellow.png)](https://paypal.me/zacanger)
Expand All @@ -22,20 +22,6 @@ Example usage:
```typescript
import * as z from 'zeelib'

if (!module.parent) {
z.termPrompt('do the thing?')
.then((yes) => {
if (yes) {
console.log(z.colorize.blue('said yes!'))
}
})
}
```

If you're using Node `require`, you'll need to access `default`:

```javascript
const zeelib = require('zeelib')

zeelib.getArgs.default()
const answer = await z.prompt('Pick a letter')
if (z.isEmpty(answer)) process.exit(1)
```
14 changes: 11 additions & 3 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
* Revive this
* Move to promise API for any Node builtins
* Bring back anything useful from old versions
* Get 100% test coverage
* Remove DOM-related stuff
* Ensure all functions have JSDocs with examples
* Update docs and changelog
* Get 100% coverage:
* Unit tests
* https://github.com/nodejs/help/issues/3902
* Types
* No ts-expect-errors
* No `any`
* No eslint-disables
* Aim for no useless imports (avoid the lodash problem)
* Aim for ES2024+/Node21+ compatibility only
* See if Node's builtin test runner can get coverage with TS yet
* Get rid of eslint/prettier, just use ts-standard
* Remove anything that can be done with plain JS now
1 change: 1 addition & 0 deletions docs/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

0 comments on commit b3f60a1

Please sign in to comment.