removed unused modules, updated readme etc

README.md

@@ -1,63 +1,63 @@
-# Project Title
+# woe-love
 
-A brief description of what this project does and who it's for
-
-## Badges
-
-![NPM](https://img.shields.io/npm/l/woe-love?style=for-the-badge)
-
-![GitHub package.json version](https://img.shields.io/github/package-json/v/azcraze/woe-love?style=for-the-badge)
-
-![GitHub commit activity](https://img.shields.io/github/commit-activity/w/azcraze/woe-love?style=for-the-badge)
-
-![GitHub last commit](https://img.shields.io/github/last-commit/azcraze/woe-love?style=for-the-badge)
+custom person module
 
 ## Installation
 
-Install my-project with npm
+This is a [Node.js](https://nodejs.org/) module available through the 
+[npm registry](https://www.npmjs.com/). It can be installed using the 
+[`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)
+or 
+[`yarn`](https://yarnpkg.com/en/)
+command line tools.
 
-```bash
-  npm install woe-love --save
+```sh
+npm install woe-love --save
 ```
 
-## Documentation
+## Tests
 
-WIP
+```sh
+npm install
+npm test
+```
 
 ## Dependencies
 
+- [-](https://ghub.io/-): custom person module
 - [@davidfig/json-depth](https://ghub.io/@davidfig/json-depth): Prettify JSON for output with a number of options, including inlining after a set depth
 - [@hero-page/hero-ai-package-creator](https://ghub.io/@hero-page/hero-ai-package-creator): Create complete NPM packages quickly and easily with the power of AI. The hero-ai-package-creator generates all necessary files and configurations for your NPM package, saving you time and effort in the development process.
 - [@karmaniverous/dirtree](https://ghub.io/@karmaniverous/dirtree): Parses a directory into a nicely-formatted ASCII tree. Includes a CLI.
 - [@tectalic/openai](https://ghub.io/@tectalic/openai): Tectalic OpenAI REST API Client
+- [1-liners](https://ghub.io/1-liners): Useful oneliners and shorthand functions
+- [app-root-path](https://ghub.io/app-root-path): Determine an app's root path from anywhere inside the app
 - [cwd](https://ghub.io/cwd): Easily get the CWD (current working directory) of a project based on package.json, optionally starting from a given path. (node.js/javascript util)
+- [dateformat](https://ghub.io/dateformat): A node.js package for Steven Levithan's excellent dateFormat() function.
+- [futils](https://ghub.io/futils): Functional programming utility toolkit
 - [gradient-string](https://ghub.io/gradient-string): Beautiful color gradients in terminal output
 - [jsome](https://ghub.io/jsome): Make your JSON look AWESOME!
 - [jsonpath](https://ghub.io/jsonpath): Query JavaScript objects with JSONPath expressions. Robust / safe JSONPath engine for Node.js.
+- [kyanite](https://ghub.io/kyanite): A small library of pure functional utilities to make life easier and data better
 - [lowline.ai](https://ghub.io/lowline.ai): An AI powered utility library
 - [luxon](https://ghub.io/luxon): Immutable date wrapper
 - [openai](https://ghub.io/openai): Node.js library for the OpenAI API
 - [path-resolver](https://ghub.io/path-resolver): returns a valid filesystem path.
 - [pretty-error](https://ghub.io/pretty-error): See nodejs errors with less clutter
 - [relative](https://ghub.io/relative): Get the relative filepath from path A to path B. Calculates from file-to-directory, file-to-file, directory-to-file, and directory-to-directory.
 - [requireindex](https://ghub.io/requireindex): Write minimal node index.js files that require and export siblings by file basename
+- [rootpath](https://ghub.io/rootpath): Little helper to make node.js require relative to your project root
 - [typy](https://ghub.io/typy): Minimal JavaScript type checking library
 - [winston](https://ghub.io/winston): A logger for just about everything.
-
-## Run Locally
-
-Clone the project
-
-```bash
-  git clone https://github.com/azcraze/woe-love.git
-```
-
-Go to the project directory
-
+- [woe-love](https://ghub.io/woe-love): custom person module
+- [woelogs](https://ghub.io/woelogs): custom package, probably won't be useful to you.
 
 ## Dev Dependencies
 
 - [@semantic-release/changelog](https://ghub.io/@semantic-release/changelog): semantic-release plugin to create or update a changelog file
+- [@semantic-release/commit-analyzer](https://ghub.io/@semantic-release/commit-analyzer): semantic-release plugin to analyze commits with conventional-changelog
+- [@semantic-release/github](https://ghub.io/@semantic-release/github): semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues
+- [@semantic-release/npm](https://ghub.io/@semantic-release/npm): semantic-release plugin to publish a npm package
+- [@semantic-release/release-notes-generator](https://ghub.io/@semantic-release/release-notes-generator): semantic-release plugin to generate changelog content with conventional-changelog
 - [ajv](https://ghub.io/ajv): Another JSON Schema Validator
 - [auto-changelog](https://ghub.io/auto-changelog): Command line tool for generating a changelog from git tags and commit history
 - [commitizen](https://ghub.io/commitizen): Git commit, but play nice with conventions.
@@ -66,59 +66,10 @@ Go to the project directory
 - [dotenv](https://ghub.io/dotenv): Loads environment variables from .env file
 - [eslint-config-prettier](https://ghub.io/eslint-config-prettier): Turns off all rules that are unnecessary or might conflict with Prettier.
 - [jest](https://ghub.io/jest): Delightful JavaScript Testing.
+- [jsdoc-to-markdown](https://ghub.io/jsdoc-to-markdown): Generates markdown API documentation from jsdoc annotated source code
 - [prettier](https://ghub.io/prettier): Prettier is an opinionated code formatter
 - [semantic-release-gitmoji](https://ghub.io/semantic-release-gitmoji): Different from conventional changelog, Gitmoji commits are used to determine a release type and generate release notes.
 
-## Running Tests
-
-To run tests, run the following command
-
-```bash
-  npm run test
-```
-
-## Roadmap
-
-- [ ] create undo functionality for score input
-- [x] fix tests
-- [ ] Complete leaderboard commands
-- [ ] Player profile commands
-
-# tests
+## License
 
-- [test-files/](./tests/test-files)
-  - [addScores.json](./tests/test-files/addScores.json)
-  - [kcScores.json](./tests/test-files/kcScores.json)
-  - [kcScoresOfficial.json](./tests/test-files/kcScoresOfficial.json)
-  - [logs.json](./tests/test-files/logs.json)
-  - [rkScores.json](./tests/test-files/rkScores.json)
-  - [skVars.json](./tests/test-files/skVars.json)
-  - [skVars.test.json](./tests/test-files/skVars.test.json)
-  - [storedVariables.json](./tests/test-files/storedVariables.json)
-  - [test-records.json](./tests/test-files/test-records.json)
-  - [writeDateToFile.test.json](./tests/test-files/writeDateToFile.test.json)
-- [test-suite/](./tests/test-suite)
-  - [date.tests/](./tests/test-suite/date.tests)
-    - [adjustDate.test.js](./tests/test-suite/date.tests/adjustDate.test.js)
-    - [currentDate.test.js](./tests/test-suite/date.tests/currentDate.test.js)
-    - [otherDateFunctions.test.js](./tests/test-suite/date.tests/otherDateFunctions.test.js)
-    - [validateDate.test.js](./tests/test-suite/date.tests/validateDate.test.js)
-  - [errorMessages.test.js](./tests/test-suite/errorMessages.test.js)
-  - [filesystem.test.js](./tests/test-suite/filesystem.test.js)
-  - [readParse.test.js](./tests/test-suite/readParse.test.js)
-  - [test.js](./tests/test-suite/test.js)
-  - [typeChecking.test.js](./tests/test-suite/typeChecking.test.js)
-  - [utils.test.js](./tests/test-suite/utils.test.js)
-  - [writeToFile.test.js](./tests/test-suite/writeToFile.test.js)
-- [~/](./tests/~)
-  - [.dotfiles/](./tests/~/.dotfiles)
-- [addScores.js](./tests/addScores.js)
-- [formatAndSortScoresTest.js](./tests/formatAndSortScoresTest.js)
-- [generateTable.test.js](./tests/generateTable.test.js)
-- [getPlayerScoresArrayTest.js](./tests/getPlayerScoresArrayTest.js)
-- [getScoresArrayTest.js](./tests/getScoresArrayTest.js)
-- [madKiller.js](./tests/madKiller.js)
-- [playerScoresDataTest.js](./tests/playerScoresDataTest.js)
-- [restructure.js](./tests/restructure.js)
-- [test-values.js](./tests/test-values.js)
-- [test.js](./tests/test.js)
+MIT

index.js

@@ -4,8 +4,8 @@ require("dotenv").config();
 
 /* ------------- Packages ------------ */
 
-const { core, filesystem, utils } = require("./lib");
-const fs = filesystem;
+const x = require("./lib");
+
 
 /* ------------------- Paths ------------------ */
 
@@ -18,30 +18,7 @@ const duck = `  __
 `;
 
 module.exports = {
-  duck: duck,
-  scores: core.scores,
-  lb: core.lb,
-  check: core.check,
-  logs: core.logs,
-  get: core.get,
-  error: require("./lib/err").error,
-  is: require("./lib/err").is,
-  logger: require("./lib/err").logger,
-  pe: require("./lib/err").pe,
-  store: require("./lib/store"),
-  date: utils.date,
-  sani: {
-    split: {
-      space: utils.split.space,
-      comma: utils.split.comma,
-      dash: utils.split.dash,
-    },
-  },
-  log: utils.log,
-  paths: fs.paths,
-  testPaths: fs.testPaths,
-  _fs: {
-    write: fs.writeToFile,
-    parse: fs.readAndParseFile,
-  },
+  duck,
+  x
+
 };