zod-openapi 0.0.0-semantically-released

package/LICENSE

@@ -0,0 +1,21 @@
+### MIT License
+
+Copyright (c) 2020 SEEK
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,128 @@
+# zod-openapi
+
+[![Powered by skuba](https://img.shields.io/badge/🤿%20skuba-powered-009DC4)](https://github.com/seek-oss/skuba)
+
+This package is intended to be public on [seek-oss].
+To create an internal package,
+run `skuba init` and select the `private-npm-package` template.
+
+Next steps:
+
+1. [ ] Read [SEEK's Open Source RFC].
+2. [ ] Create a new repository in the [seek-oss] GitHub organisation.
+3. [ ] Push local commits to the upstream GitHub branch.
+4. [ ] Configure [GitHub repository settings].
+5. [ ] Keep dependencies up to date with [Renovate];
+       request installation in [#open-source].
+6. [ ] Delete this checklist 😌.
+
+[#open-source]: https://slack.com/app_redirect?channel=C39P1H2SU
+[github repository settings]: https://github.com/seek-oss/zod-openapi/settings
+[renovate]: https://github.com/apps/renovate
+[seek's open source rfc]: https://rfc.skinfra.xyz/RFC016-Open-Source.html
+
+## API
+
+### `log`
+
+Writes the module name to stdout.
+Thrilling stuff.
+
+```typescript
+import { log } from 'zod-openapi';
+
+log();
+```
+
+## Development
+
+### Prerequisites
+
+- Node.js LTS
+- Yarn 1.x
+
+```shell
+yarn install
+```
+
+### Test
+
+```shell
+yarn test
+```
+
+### Lint
+
+```shell
+# Fix issues
+yarn format
+
+# Check for issues
+yarn lint
+```
+
+### Package
+
+```shell
+# Compile source
+yarn build
+
+# Review bundle
+npm pack
+```
+
+## Release
+
+This package is published to the public npm registry with a GitHub Actions [release workflow].
+
+The workflow runs on select branches:
+
+```yaml
+on:
+  push:
+    branches:
+      # add others as necessary
+      - beta
+      - master
+      # - alpha
+```
+
+It depends on this repo being hosted on [seek-oss] with appropriate access.
+
+To set up this repo for publishing, follow the instructions in our [OSS npm package guidance].
+
+### Commit messages
+
+This package is published with **[semantic-release]**, which requires a particular commit format to manage semantic versioning.
+You can run the interactive `yarn commit` command in place of `git commit` to generate a compliant commit title and message.
+If you use the `Squash and merge` option on pull requests, take extra care to format the squashed commit in the GitHub UI before merging.
+
+### Releasing latest
+
+Commits to the `master` branch will be released with the `latest` tag,
+which is the default used when running `npm install` or `yarn install`.
+
+### Releasing other dist-tags
+
+**[semantic-release]** prescribes a branch-based workflow for managing [distribution tags].
+
+You can push to other branches to manage betas, maintenance updates to prior major versions, and more.
+
+Here are some branches that **semantic-release** supports by default:
+
+| Git branch | npm dist-tag |
+| :--------- | :----------- |
+| master     | latest       |
+| alpha      | alpha        |
+| beta       | beta         |
+| next       | next         |
+| 1.x        | release-1.x  |
+
+For more information, see the **semantic-release** docs on [triggering a release].
+
+[distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
+[oss npm package guidance]: https://github.com/SEEK-Jobs/seek-oss-ci/blob/master/NPM_PACKAGES.md#access-to-publish-to-npm
+[release workflow]: .github/workflows/release.yml
+[seek-oss]: https://github.com/seek-oss
+[semantic-release]: https://github.com/semantic-release/semantic-release
+[triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release

package/lib-commonjs/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.log = void 0;
+/**
+ * Writes the module name to stdout.
+ * Thrilling stuff.
+ */
+const log = () => 
+/* eslint-disable-next-line no-console */
+console.log('zod-openapi');
+exports.log = log;
+//# sourceMappingURL=index.js.map

package/lib-commonjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACI,MAAM,GAAG,GAAG,GAAG,EAAE;AACtB,yCAAyC;AACzC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;AAFhB,QAAA,GAAG,OAEa"}

package/lib-es2015/index.js

@@ -0,0 +1,8 @@
+/**
+ * Writes the module name to stdout.
+ * Thrilling stuff.
+ */
+export const log = () => 
+/* eslint-disable-next-line no-console */
+console.log('zod-openapi');
+//# sourceMappingURL=index.js.map

package/lib-es2015/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,GAAG,EAAE;AACtB,yCAAyC;AACzC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC"}

package/lib-types/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Writes the module name to stdout.
+ * Thrilling stuff.
+ */
+export declare const log: () => void;

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "zod-openapi",
+  "version": "0.0.0-semantically-released",
+  "description": "Zod OpenAPI Plugin",
+  "homepage": "https://github.com/seek-oss/zod-openapi#readme",
+  "bugs": {
+    "url": "https://github.com/seek-oss/zod-openapi/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/seek-oss/zod-openapi.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "main": "./lib-commonjs/index.js",
+  "module": "./lib-es2015/index.js",
+  "types": "./lib-types/index.d.ts",
+  "files": [
+    "lib*/**/*.d.ts",
+    "lib*/**/*.js",
+    "lib*/**/*.js.map",
+    "lib*/**/*.json"
+  ],
+  "scripts": {
+    "build": "skuba build-package",
+    "commit": "cz",
+    "format": "skuba format",
+    "lint": "skuba lint",
+    "release": "yarn build && skuba release",
+    "test": "skuba test",
+    "test:ci": "skuba test --coverage",
+    "test:watch": "skuba test --watch"
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^16.18.3",
+    "commitizen": "^4.2.4",
+    "skuba": "6.0.0"
+  },
+  "engines": {
+    "node": ">=16.11"
+  },
+  "skuba": {
+    "entryPoint": "src/index.ts",
+    "template": "oss-npm-package",
+    "type": "package",
+    "version": "6.0.0"
+  }
+}