Merge pull request #17 from lornajane/package-prep

Prepare to publish as a package

Author: lornajane

README.md

@@ -14,13 +14,15 @@ Overlays are a way to extend or enhance an existing [OpenAPI description](https:
 
 ## Installation
 
-This project isn't published as a package yet, so:
+Install the `overlayjs` command from [npm](https://npmjs.com) with the following command:
 
-* Clone this repo
-* Run `npm install` to get the dependencies
-* Run `npm install -g` to get `overlayjs` as a command
+```text
+npm install -g openapi-overlay-js
+```
 
-> **Pro-tip:** you can also use `node index.js` from the root of the project if you don't want to install a global command.
+The `-g` switch installs it globally so you can use the command from anywhere on your system.
+
+> **Pro-tip:** use `node index.js` from the root of the project if you're using the bleeding edge of the project or working on a branch.
 
 ## Usage
 
@@ -32,6 +34,6 @@ See [docs/examples](docs/examples/index.md) for more examples.
 
 ## Project status
 
-This project is very much at idea stage but feedback, comments and questions are all very welcome as issues on this repository - and pull requests are also gratefully received. It would be excellent to hear what problem this tool can solve, and how you get on with it. Bonus points if you can share examples (working or broken) of what you tried.
+:warning: Project status: alpha
 
-:warning: please be aware that absolutely anything may change at any time, it would probably be safest to pin to a specific commit for now.
+This project is very much at an alpha stage but feedback, comments and questions are all very welcome as issues on this repository - and pull requests are also gratefully received. It would be excellent to hear what problem this tool can solve, and how you get on with it. Bonus points if you can share examples (working or broken) of what you tried.

index.js

@@ -1,26 +1,31 @@
 #!/usr/bin/env node
 import arg from 'arg'
+import fs from 'fs'
 import { overlayFiles } from './src/overlay.js'
 
 function showHelp () {
   console.log('Usage: overlayjs --openapi FILEPATH --overlay FILEPATH')
   console.log('    use --help to see this help')
 }
 
+// Function to read the version from package.json
+function showVersion () {
+  const packageJsonPath = './package.json'
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+  console.log(packageJson.version)
+}
+
 try {
   const args = arg({
     '--openapi': String,
     '--overlay': String,
+    '--version': Boolean,
     '--help': Boolean
   })
 
-  if (args['--overlay'] && args['--openapi']) {
-    const openapiFile = args['--openapi']
-    const overlayFile = args['--overlay']
-    const spec = overlayFiles(openapiFile, overlayFile)
-    console.log(spec)
-  } else {
-    showHelp()
+  if (args['--version']) {
+    showVersion()
+    process.exit(0)
   }
 
   if (args['--overlay'] && args['--openapi']) {

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "preparse",
-  "version": "1.0.0",
-  "description": "",
+  "name": "openapi-overlays-js",
+  "version": "0.1.0",
+  "description": "Tool to apply OpenAPI overlays, built in NodeJS with a command line interface (CLI).",
   "main": "index.js",
   "bin": {
     "overlayjs": "./index.js"
@@ -12,7 +12,7 @@
     "fmt": "eslint . --config .eslintrc.json --fix"
   },
   "type": "module",
-  "author": "",
+  "author": "Lorna Mitchell <[email protected]>",
   "license": "Apache2",
   "dependencies": {
     "@stoplight/yaml": "^4.2.3",