Skip to content

Commit

Permalink
v4.8.0 - boundation, changelog, version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
balupton committed Dec 27, 2023
1 parent 79d4e1f commit fe4bc73
Show file tree
Hide file tree
Showing 5 changed files with 691 additions and 1,093 deletions.
5 changes: 5 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# History

## v4.8.0 2023 December 28

- Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
- Thank you to the sponsors: [Andrew Nesbitt](https://nesbitt.io), [Balsa](https://balsa.com), [Codecov](https://codecov.io/), [Poonacha Medappa](https://poonachamedappa.com), [Rob Morris](https://github.com/Rob-Morris), [Sentry](https://sentry.io), [Syntax](https://syntax.fm)

## v4.7.0 2023 December 6

- Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
Expand Down
8 changes: 4 additions & 4 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<!-- LICENSEFILE/ -->

<h1>License</h1>
# License

Unless stated otherwise all works are:

<ul><li>Copyright &copy; 2018+ <a href="https://balupton.com">Benjamin Lupton</a></li></ul>
- Copyright &copy; [Benjamin Lupton](https://balupton.com)

and licensed under:

<ul><li><a href="http://spdx.org/licenses/Artistic-2.0.html">Artistic License 2.0</a></li></ul>
- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)

<h2>The Artistic License 2.0</h2>
## The Artistic License 2.0

<pre>
Copyright (c) 2000-2006, The Perl Foundation.
Expand Down
125 changes: 68 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<!-- TITLE/ -->

<h1>valid-directory</h1>
# valid-directory

<!-- /TITLE -->


<!-- BADGES/ -->

<span class="badge-githubworkflow"><a href="https://github.com/bevry/valid-directory/actions?query=workflow%3Abevry" title="View the status of this project's GitHub Workflow: bevry"><img src="https://github.com/bevry/valid-directory/workflows/bevry/badge.svg" alt="Status of the GitHub Workflow: bevry" /></a></span>
Expand All @@ -25,7 +24,6 @@

<!-- /BADGES -->


<!-- DESCRIPTION/ -->

Check whether or not a directory and its descendants are valid
Expand Down Expand Up @@ -77,73 +75,69 @@ To validate your packages before you publish them, you can do the following:

<!-- INSTALL/ -->

<h2>Install</h2>
## Install

<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>npm</h3></a>
<h4>Install Globally</h4>
<ul>
<li>Install: <code>npm install --global valid-directory</code></li>
<li>Executable: <code>valid-directory</code></li>
</ul>
<h4>Install Locally</h4>
<ul>
<li>Install: <code>npm install --save valid-directory</code></li>
<li>Executable: <code>npx valid-directory</code></li>
<li>Import: <code>import pkg from ('valid-directory')</code></li>
<li>Require: <code>const pkg = require('valid-directory').default</code></li>
</ul>
### [npm](https://npmjs.com "npm is a package manager for javascript")

<a href="https://deno.land" title="Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js"><h3>Deno</h3></a>
#### Install Globally

``` typescript
import pkg from 'https://unpkg.com/valid-directory@^4.7.0/edition-deno/index.ts'
```
- Install: `npm install --global valid-directory`
- Executable: `valid-directory`

<h3><a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
#### Install Locally

<p>This package is published with the following editions:</p>
- Install: `npm install --save valid-directory`
- Executable: `npx valid-directory`
- Import: `import pkg from ('valid-directory')`
- Require: `const pkg = require('valid-directory').default`

<ul><li><code>valid-directory/source/index.ts</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> source code with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
<li><code>valid-directory</code> aliases <code>valid-directory/edition-es2022/index.js</code></li>
<li><code>valid-directory/edition-es2022/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against ES2022 for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 18 || 20 || 21 with <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a> for modules</li>
<li><code>valid-directory/edition-es2022-esm/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against ES2022 for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 18 || 20 || 21 with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
<li><code>valid-directory/edition-types/index.d.ts</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled Types with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
<li><code>valid-directory/edition-deno/index.ts</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> source code made to be compatible with <a href="https://deno.land" title="Deno is a secure runtime for JavaScript and TypeScript, it is an alternative to Node.js">Deno</a></li></ul>
### [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js")

<!-- /INSTALL -->
``` typescript
import pkg from 'https://unpkg.com/valid-directory@^4.8.0/edition-deno/index.ts'
```
### [Editions](https://editions.bevry.me "Editions are the best way to produce and consume packages you care about.")

This package is published with the following editions:
- `valid-directory/source/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `valid-directory` aliases `valid-directory/edition-es2022/index.js`
- `valid-directory/edition-es2022/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
- `valid-directory/edition-es2022-esm/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 18 || 20 || 21 with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `valid-directory/edition-types/index.d.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled Types with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `valid-directory/edition-deno/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code made to be compatible with [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative to Node.js")

<!-- /INSTALL -->

<!-- HISTORY/ -->

<h2>History</h2>
## History

<a href="https://github.com/bevry/valid-directory/blob/master/HISTORY.md#files">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a>
[Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/valid-directory/blob/HEAD/HISTORY.md#files)

<!-- /HISTORY -->

<!-- BACKERS/ -->

<!-- CONTRIBUTE/ -->

<h2>Contribute</h2>

<a href="https://github.com/bevry/valid-directory/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
## Backers

<!-- /CONTRIBUTE -->
### Code

[Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/valid-directory/blob/HEAD/CONTRIBUTING.md#files)

<!-- BACKERS/ -->
#### Authors

<h2>Backers</h2>
- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.

<h3>Maintainers</h3>
#### Maintainers

These amazing people are maintaining this project:
- [Benjamin Lupton](https://github.com/balupton) — Accelerating collaborative wisdom.

<ul><li><a href="https://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/valid-directory/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/valid-directory">view contributions</a></li></ul>
#### Contributors

<h3>Sponsors</h3>
- [Benjamin Lupton](https://github.com/balupton)[view contributions](https://github.com/bevry/valid-directory/commits?author=balupton "View the GitHub contributions of Benjamin Lupton on repository bevry/valid-directory")
- [Sumit Rai](https://github.com/sumitrai)[view contributions](https://github.com/bevry/valid-directory/commits?author=sumitrai "View the GitHub contributions of Sumit Rai on repository bevry/valid-directory")

No sponsors yet! Will you be the first?
### Finances

<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
<span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
Expand All @@ -154,28 +148,45 @@ No sponsors yet! Will you be the first?
<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>

<h3>Contributors</h3>

These amazing people have contributed code to this project:

<ul><li><a href="https://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/valid-directory/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/valid-directory">view contributions</a></li>
<li><a href="https://github.com/sumitrai">Sumit Rai</a> — <a href="https://github.com/bevry/valid-directory/commits?author=sumitrai" title="View the GitHub contributions of Sumit Rai on repository bevry/valid-directory">view contributions</a></li></ul>

<a href="https://github.com/bevry/valid-directory/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
#### Sponsors

- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher
- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.
- [Codecov](https://codecov.io/) — Empower developers with tools to improve code quality and testing.
- [Poonacha Medappa](https://poonachamedappa.com)
- [Rob Morris](https://github.com/Rob-Morris)
- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.
- [Syntax](https://syntax.fm) — Syntax Podcast

#### Donors

- [Andrew Nesbitt](https://nesbitt.io)
- [Balsa](https://balsa.com)
- [Chad](https://opencollective.com/chad8)
- [Codecov](https://codecov.io/)
- [entroniq](https://gitlab.com/entroniq)
- [Jean-Luc Geering](https://github.com/jlgeering)
- [Michael Duane Mooring](https://mdm.cc)
- [Mohammed Shah](https://github.com/smashah)
- [Poonacha Medappa](https://poonachamedappa.com)
- [Rob Morris](https://github.com/Rob-Morris)
- [Sentry](https://sentry.io)
- [ServieJS](https://github.com/serviejs)
- [Skunk Team](https://skunk.team)
- [Syntax](https://syntax.fm)

<!-- /BACKERS -->


<!-- LICENSE/ -->

<h2>License</h2>
## License

Unless stated otherwise all works are:

<ul><li>Copyright &copy; 2018+ <a href="https://balupton.com">Benjamin Lupton</a></li></ul>
- Copyright &copy; [Benjamin Lupton](https://balupton.com)

and licensed under:

<ul><li><a href="http://spdx.org/licenses/Artistic-2.0.html">Artistic License 2.0</a></li></ul>
- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)

<!-- /LICENSE -->
Loading

0 comments on commit fe4bc73

Please # to comment.