Skip to content

Commit

Permalink
-Updated testing code function and guide
Browse files Browse the repository at this point in the history
1. added test function
2. updated contributting
  • Loading branch information
juuuuuuun committed Nov 15, 2021
1 parent b532d8c commit 5236cd2
Show file tree
Hide file tree
Showing 11 changed files with 3,522 additions and 451 deletions.
3 changes: 2 additions & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"env": {
"commonjs": true,
"es2021": true,
"node": true
"node": true,
"jest/globals": true
},
"extends": "eslint:recommended",
"parserOptions": {
Expand Down
15 changes: 14 additions & 1 deletion CONTRIBUTTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
## Usage

Formatting:

- `npm run prettier`: Format files by Prettier.
- `npm run prettier-check`: Check the files are formatted or not.

Expand All @@ -17,18 +18,30 @@ Formatting:
## Usage

Running:

- `npm run eslint`: Show the errors from the files by Eslint.
- `npm run eslint-fix`: Fix the errors from the files by Eslint.

## Setting

- You can change Prettier setting in `.eslintrc.json`

# Vscode
# Vscode

- Prettier: `esbenp.prettier-vscode`
- ESLint: `dbaeumer.vscode-eslint`

- It will automatically set the Prettier and ESLint as a default option to your Vscode.

# Test the SSG

## Usage

- `npm test` or `npm run test` : test the code by in _test_ dir.
- `npm test:cover` or `npm run test:cover` : test the code by set coverage.

## Setting

- You can change jest(for testing) setting in `jest.config.js`

![footer](https://capsule-render.vercel.app/api?type=waving&color=auto&height=500&section=footer&text=Jun%20Song&desc=Student%20of%20Seneca%20College&animation=fadeIn&fontSize=70)
13 changes: 3 additions & 10 deletions dist/Silver Blaze.html
Original file line number Diff line number Diff line change
@@ -1,18 +1,11 @@
<!doctype html>
<html lang="ko">
<html lang="en">
<head>
<meta charset="utf-8">
<title>Silver Blaze.txt</title>
<link rel="stylesheet" href=https://cdn.jsdelivr.net/npm/water.css@2/out/water.css>

<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
body {
background-color: #292929;
}
h1, h2, h3, h4, h5, h6, b, strong, th, p, a, xmp, code{
color: #fff;
}
</style>
undefined

</head>
<body>
Expand Down
20 changes: 4 additions & 16 deletions dist/index.html
Original file line number Diff line number Diff line change
@@ -1,27 +1,15 @@
<!doctype html>
<html lang="ko">
<html lang="en">
<head>
<meta charset="utf-8">
<title>ssg-html</title>
<link rel="stylesheet" href=https://cdn.jsdelivr.net/npm/water.css@2/out/water.css>

<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
body {
background-color: #292929;
}
h1, h2, h3, h4, h5, h6, b, strong, th, p, a, xmp, code{
color: #fff;
}
</style>
undefined

</head>
<body>
<!-- Your generated content here... -->
<h1>Sherlock-Holmes-Selected-Stories - Information Page</h1></n><a href="./README.html">README</a></br>
<a href="./Silver Blaze.html">Silver Blaze</a></br>
<a href="./The Adventure of the Six Napoleans.html">The Adventure of the Six Napoleans</a></br>
<a href="./The Adventure of the Speckled Band.html">The Adventure of the Speckled Band</a></br>
<a href="./The Naval Treaty.html">The Naval Treaty</a></br>
<a href="./The Red Headed League.html">The Red Headed League</a></br>
<h1>Sherlock-Holmes-Selected-Stories/Silver Blaze.txt - Information Page</h1></n><a href="./Silver Blaze.html">Silver Blaze</a></br>
</body>
</html>
194 changes: 194 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
/*
* 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\\isong\\AppData\\Local\\Temp\\jest",

// Automatically clear mock calls and instances between every test
// clearMocks: false,

// 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,

// 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",
// "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 between 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 between 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: [
// "**/__tests__/**/*.[jt]s?(x)",
// "**/?(*.)+(spec|test).[tj]s?(x)"
// ],

// 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",

// This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
// testURL: "http://localhost",

// Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
// timers: "real",

// 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,
};
Loading

0 comments on commit 5236cd2

Please sign in to comment.