Merge pull request #46 from Guilded-Bot-NPM/v1.0.3

V1.0.3

.github/workflows/release.yml

@@ -2,12 +2,8 @@ on:
   push:
     branches:
       - master
-    tags:
-    # Push events to matching like v1.0.0, v20.15.10, etc.
-    # If the tag is like "version 1.0.0" or "var 1.0.0" then it will not be matched
-      - 'v[0-9]+.[0-9]+.[0-9]+'
 
-name: Release
+name: Publish Release
 jobs:
   # New job, this job is called "docs" and will run on the latest version of Ubuntu
   # This job will run the "actions/checkout@v2" action to check out the code
@@ -51,7 +47,7 @@ jobs:
         with:
           node-version: 16
       - name: Install dependencies
-        run: npm ci
+        run: npm ci & npm i jest -g
       - name: Run tests
         run: npm run test
 
@@ -90,7 +86,7 @@ jobs:
         uses: marvinpinto/action-automatic-releases@v1.2.1
         with:
           repo_token: ${{ secrets.ACCESS_TOKEN }}
-          automatic_release_tag: v${{ env.NODE_VERSION }}
+          automatic_release_tag: ${{ env.NODE_VERSION }}
           draft: false
           prerelease: false
           title: Release ${{ env.NODE_VERSION }}

.github/workflows/test_unit.yml

@@ -0,0 +1,38 @@
+on:
+# Check every time a pull request is made in every branch
+  pull_request:
+    branches:
+      - '*'
+
+name: Test Unit
+jobs:
+  docs:
+    name: Generate documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - name: Install JSDoc
+        run: npm i jsdoc -g
+      - name: Generate documentation
+        run: npm run docs-gh
+
+  release:
+    name: Test Unit
+    needs: docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Setup Node.js 
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci & npm i jest -g
+      - name: Run tests
+        run: npm run test

.gitignore

@@ -4,4 +4,6 @@ src/test
 node_modules
 
 docs
-out
+out
+
+coverage

jest.config.js

@@ -0,0 +1,195 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "C:\\Users\\Usuario\\AppData\\Local\\Temp\\jest",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    // All files in the test directory that end with .test.js
+    "**/test/**/*.test.js"
+  ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "\\\\node_modules\\\\",
+  //   "\\.pnp\\.[^\\\\]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package.json

@@ -1,14 +1,14 @@
 {
   "name": "guilded-bot",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A library for interacting with the Guilded API for your Guilded Bot",
   "main": "src/index.js",
   "scripts": {
-    "dev": "nodemon --trace-warnings src/test/index.js",
+    "dev": "nodemon --trace-warnings test/index.test.js",
     "start": "node src/index.js",
     "docs": "jsdoc --readme ./README.md -c ./jsdocs.json ./src/index.js --verbose",
     "docs-gh": "jsdoc --readme ./README.md -c ./jsdocs-gh.json ./src/index.js --verbose --destination ./docs",
-    "test": "echo \"Error: no tests for now\" && exit 0"
+    "test": "jest --coverage --verbose"
   },
   "keywords": [
     "guilded",

src/classes/Structures/User/Member.js

@@ -1,4 +1,4 @@
-const { User } = require("./User");
+const { User } = require("./user");
 
 class Member {
   /**

src/classes/Structures/User/MemberBan.js

@@ -1,4 +1,4 @@
-const { UserSummary } = require('./UserSummary');
+const { UserSummary } = require('./usersummary');
 
 class MemberBan {
     /**

src/classes/Structures/User/User.js

@@ -1,4 +1,4 @@
-const guser = require('../../../Helper/Members.js')
+const guser = require('../../../helper/members.js')
 
 class User {
   /**