Merge pull request #213 from beakerandjake/feature/initial-release

Feature/initial release

Author: beakerandjake

.github/workflows/publish.yml

@@ -117,4 +117,3 @@ jobs:
           tag_name: ${{ env.NEW_VERSION }}
           prerelease: ${{ startsWith(github.event.inputs.release-type, 'pre') }}
           body: ${{ steps.get-changelog.outputs.changelog }}
-

CHANGELOG.md

@@ -7,41 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.3.2-beta.5] - 2023-02-09
 
-## [1.3.2-beta.4] - 2023-02-08
+## [1.3.2] - 2023-02-09
 
-## [1.3.2-beta.3] - 2023-02-01
-### Fixed
-- Github Action generates correct tag name
+- Initial Release
 
-## [1.3.2-beta.2] - 2023-02-01
-### Added
-- First pass Github Actions for publishing to NPM / Creating github Release
-
-## [1.3.2-beta.1] - 2023-01-31
-
-## [1.3.2-beta.0] - 2023-01-31
-
-## [1.3.1] - 2023-01-31
-### Added
-- Created github action to create release pull requests.
-
-## [1.3.1-beta.4] - 2023-01-30
-### Fixed
-- Fix links to releases not appended to bottom of CHANGELOG.
-
-## [1.3.1-beta.3] - 2023-01-30
-### Added
-- CHANGELOG is automatically updated during github release action.
-
-[Unreleased]: https://github.com/beakerandjake/advent-of-code-runner/compare/v1.3.2-beta.5...HEAD
-[1.3.2-beta.5]: https://github.com/beakerandjake/advent-of-code-runner/compare/v1.3.2-beta.4...v1.3.2-beta.5
-[1.3.2-beta.4]: https://github.com/beakerandjake/advent-of-code-runner/compare/v1.3.2-beta.3...v1.3.2-beta.4
-[1.3.2-beta.3]: https://github.com/beakerandjake/advent-of-code-runner/compare/v1.3.2-beta.2...v1.3.2-beta.3
-[1.3.2-beta.2]: https://github.com/beakerandjake/advent-of-code-runner/compare/v1.3.2-beta.1...v1.3.2-beta.2
-[1.3.2-beta.1]: https://github.com/beakerandjake/advent-of-code-runner/compare/v1.3.2-beta.0...v1.3.2-beta.1
-[1.3.2-beta.0]: https://github.com/beakerandjake/advent-of-code-runner/compare/v1.3.1...v1.3.2-beta.0
-[1.3.1]: https://github.com/beakerandjake/advent-of-code-runner/compare/v1.3.1-beta.4...v1.3.1
-[1.3.1-beta.4]: https://github.com/beakerandjake/advent-of-code-runner/compare/v1.3.1-beta.3...v1.3.1-beta.4
-[1.3.1-beta.3]: https://github.com/beakerandjake/advent-of-code-runner/releases/tag/v1.3.1-beta.3
+[Unreleased]: https://github.com/beakerandjake/advent-of-code-runner/compare/v1.3.2...HEAD
+[1.3.2]: https://github.com/beakerandjake/advent-of-code-runner/releases/tag/v1.3.2

CONTRIBUTING.md

@@ -61,7 +61,7 @@ npm install
 ```
 
 #### `npm start`
-This is the command to run the program for development. It runs a the `scripts/start.js` file. 
+This is the command to run the program for development. It runs the `scripts/start.js` file. 
 
 This file contains some logic to ensure local development is easy:
 - A working directory is created (if it does not exist) at the root of the repository called `development`. This folder acts as the cwd when running commands, it is ignored by git.
@@ -130,7 +130,7 @@ The chain runs these links in order:
   3. `getNextUnsolvedPuzzle` - Searches the user data file for the first puzzle the user has not solved, the puzzle day and level are added to the chain args. 
   4. `outputPuzzleLink` - Prints a link to the puzzle in the terminal. 
 
-The order of the links is very important. Some links expect certain args to be present and will fail if those ars are missing. For instance `outputPuzzleLink` requires an args object like `{ year, day, level }`. These fields are added to the args object by the earlier links `getYear` and `getNextUnsolvedPuzzle`.
+Since the links in a chain are executed sequentially, the order of the links is very important. Some links expect certain args to be present and will fail if those ars are missing. For instance `outputPuzzleLink` requires an args object like `{ year, day, level }`. These fields are added to the args object by the earlier links `getYear` and `getNextUnsolvedPuzzle`.
 
 ## Tests
 [Jest](https://github.com/facebook/jest) is used for unit testing. There is no set coverage target, but the goal is to have as many quality tests as possible. 

README.md

@@ -18,7 +18,7 @@ A Node.Js CLI solution generator and runner for [advent of code](https://advento
 - Stores and outputs statistics to the CLI or your README file.
 - Rate limits submissions to prevent timeout penalties.
 - Tracks your progress and knows which puzzle to run.
-- Uses modern ECMAScript modules (ESM).
+- Uses ECMAScript modules (ESM).
 
 ## :deer: Table of Contents
 - [Installation](#milk_glass-installation)
@@ -63,7 +63,7 @@ your-repository-folder/
 advent of code generates puzzle inputs unique to your account. In order to download inputs and submit answers this CLI needs to store your advent of code authentication token. The token will be stored in a .env file in your project directory. This .env file ***should not*** be committed to source control. When you run the `init` command a .gitignore file is generated which ignores .env files, so *your token is safe by default*. 
 
 #### Finding your Authentication Token
-The authentication token is stored in a advent of code cookie. Navigate to [advent of code](https://adventofcode.com/), and sign in to your account. Once signed in open up your browsers development tools, find the cookies for adventofcode.com and copy the value of the "session" cookie. 
+The authentication token is stored in an advent of code cookie. Navigate to [advent of code](https://adventofcode.com/), and sign in to your account. Once signed in open up your browsers development tools, find the cookies for adventofcode.com and copy the value of the "session" cookie. 
 - [Firefox help](https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/index.html)
 - [Chrome help](https://developer.chrome.com/docs/devtools/storage/cookies/)
 
@@ -161,10 +161,10 @@ If you run the command with the `--save` argument then the table will be saved t
 ```
 npm run stats -- --save
 ```
-Note you must add `--` seperator between the command name and the `--save` argument. See this [stackoverflow question](https://stackoverflow.com/q/11580961) for more info.
+Note you must add `--` separator between the command name and the `--save` argument. See this [stackoverflow question](https://stackoverflow.com/q/11580961) for more info.
 
 ### `auth`
-Creates or updates the `.env` file with your advent of code authentication token. This is a useful command if you checkout your repository on a new machine, since the `.env` file is not commited to source control and wont be present on the new machine.
+Creates or updates the `.env` file with your advent of code authentication token. This is a useful command if you checkout your repository on a new machine, since the `.env` file is not committed to source control and wont be present on the new machine.
 
 ```
 npm run auth
@@ -191,7 +191,7 @@ These functions:
 ### Arguments
 Solution functions are invoked with a single argument, an object containing the following fields:
 - `input: string`: A string containing the raw, unprocessed puzzle input. Provided for flexibility and custom parsing.
-- `lines: string[]`:  An array of strings containing the each line of the puzzle input. Provided for convience and speed. 
+- `lines: string[]`:  An array of strings containing the each line of the puzzle input. Provided for convenience and speed. 
 
 Depending on the puzzle and its input you might need to [parse string values into integers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/parseInt). 
 
@@ -202,10 +202,10 @@ This CLI downloads puzzles inputs only once and saves them to the `inputs/` fold
 ## :gift: Misc File Information
 
 #### `aocr-data.json`
-This file stores your progress. Every time you submit an answer, it is stored in this file to prevent duplicate submissions and track statistics. Additionally it stores the fastest recorded runtime for each puzzle. You should not edit this file manually. This file should be commited to source control. 
+This file stores your progress. Every time you submit an answer, it is stored in this file to prevent duplicate submissions and track statistics. Additionally it stores the fastest recorded runtime for each puzzle. You should not edit this file manually. This file should be committed to source control. 
 
 #### `.ratelimits.json`
-This file stores rate limit information used when querying the advent of code website. The creator of the website has requested automated tools such as this CLI are conservative in the number of requests made to the website. This file tracks when the last request was made and the CLI uses this data to prevent requests from occuring too frequently. This file is ignored in source control.
+This file stores rate limit information used when querying the advent of code website. The creator of the website has requested automated tools such as this CLI are conservative in the number of requests made to the website. This file tracks when the last request was made and the CLI uses this data to prevent requests from occurring too frequently. This file is ignored in source control.
 
 #### `.env`
 This file stores your authentication token, it ***should not be committed to source control***. See the [Authentication Token](https://github.com/beakerandjake/advent-of-code-runner#authentication-token) section for more information.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "advent-of-code-runner",
-  "version": "1.3.2-beta.5",
+  "version": "1.3.2",
   "description": "CLI for running and submitting Advent of Code Puzzles",
   "keywords": [
     "adventofcode",

package.json

@@ -66,7 +66,7 @@ const CONFIG = {
   },
   aoc: {
     authenticationToken: process.env[envOptions.authenticationToken] || null,
-    baseUrl: 'http://192.168.0.1', // 'https://adventofcode.com',
+    baseUrl: 'https://adventofcode.com',
     userAgent: 'https://github.com/beakerandjake/advent-of-code-runner by beakerandjake',
     responseParsing: {
       correctSolution: /that's the right answer/gim,