move sources to src/ directory

Author: rhysd

.gitignore

@@ -1,6 +1,6 @@
 /node_modules
-/*.js
-/*.js.map
+/src/*.js
+/src/*.js.map
 /examples/rust/Cargo.lock
 /examples/rust/target
 /test/*.js

CONTRIBUTING.md

@@ -5,8 +5,8 @@ Development
 
 Adding support for new benchmaking tools is welcome!
 
-1. Add your tool name in `config.ts`
-2. Implement the logic to extract benchmark results from output in `extract.ts`
+1. Add your tool name in `src/config.ts`
+2. Implement the logic to extract benchmark results from output in `src/extract.ts`
 3. Add tests for your tool under `test/*.ts`
 4. Add your tool's color in `default_index_html.ts`
 5. Add example project under `examples/` directory
@@ -34,4 +34,4 @@ And for another example, here are commits to add support for `pytest-benchmark`:
 1. Run `$ bash scripts/prepare-release.sh v1`
 2. Check changes with `git diff --cached`
 3. If ok, create a new commit and tag it with `v1.x.y`
-4. Push to `v1` remote repository and make a release on GitHub
+4. Push the commit and tag to `v1` remote repository and make a release on GitHub

action.yml

@@ -61,4 +61,4 @@ inputs:
 
 runs:
   using: 'node12'
-  main: 'index.js'
+  main: 'src/index.js'

package.json

@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "private": true,
   "description": "",
-  "main": "index.js",
+  "main": "src/index.js",
   "scripts": {
     "build": "tsc -p .",
     "watch:tsc": "tsc -p . --watch --preserveWatchOutput",

scripts/ci_validate_modification.ts

@@ -1,9 +1,9 @@
 import * as path from 'path';
 import { promises as fs } from 'fs';
 import * as cp from 'child_process';
-import { DataJson, BenchmarkSuites, SCRIPT_PREFIX } from '../write';
-import { VALID_TOOLS } from '../config';
-import { Benchmark } from '../extract';
+import { DataJson, BenchmarkSuites, SCRIPT_PREFIX } from '../src/write';
+import { VALID_TOOLS } from '../src/config';
+import { Benchmark } from '../src/extract';
 import { diff, Diff, DiffNew, DiffEdit, DiffArray } from 'deep-diff';
 import deepEq = require('deep-equal');
 

scripts/prepare-release.sh

@@ -42,18 +42,21 @@ npm prune --production
 rm -rf .release
 mkdir -p .release
 
-cp action.yml *.js package.json package-lock.json .release/
+cp action.yml src/*.js package.json package-lock.json .release/
 cp -R node_modules .release/node_modules
 
 git checkout "$version"
 git pull
-rm -rf node_modules
+git rm -rf node_modules
+rm -rf node_modules  # remove node_modules/.cache
+mkdir -p src
+
 mv .release/action.yml .
-mv .release/*.js .
+mv .release/*.js ./src/
 mv .release/*.json .
 mv .release/node_modules .
 
-git add action.yml *.js *.json node_modules
+git add action.yml ./src/*.js package.json package-lock.json node_modules
 set +x
 
 echo "Done. Please check 'git diff --cached' to verify changes. If ok, add version tag and push it to remote"

config.ts src/config.ts

@@ -18,7 +18,7 @@ mock('@actions/core', {
 });
 
 // This line must be called after mocking
-const { configFromJobInput, VALID_TOOLS } = require('../config');
+const { configFromJobInput, VALID_TOOLS } = require('../src/config');
 
 describe('configFromJobInput()', function() {
     const cwd = process.cwd();

default_index_html.ts src/default_index_html.ts

@@ -1,7 +1,7 @@
 import { strict as A } from 'assert';
 import * as cheerio from 'cheerio';
 import { Parser as JsParser } from 'acorn';
-import { DEFAULT_INDEX_HTML } from '../default_index_html';
+import { DEFAULT_INDEX_HTML } from '../src/default_index_html';
 
 describe('DEFAULT_INDEX_HTML', function() {
     it('is valid HTML and its script is valid as JavaScript', function() {

extract.ts src/extract.ts

@@ -1,7 +1,7 @@
 import * as path from 'path';
 import { strict as A } from 'assert';
 import mock = require('mock-require');
-import { BenchmarkResult } from '../extract';
+import { BenchmarkResult } from '../src/extract';
 
 mock('@actions/github', {
     context: {
@@ -12,7 +12,7 @@ mock('@actions/github', {
     },
 });
 
-const { extractResult } = require('../extract');
+const { extractResult } = require('../src/extract');
 
 describe('extractResult()', function() {
     after(function() {

git.ts src/git.ts

@@ -41,7 +41,7 @@ mock('@actions/github', {
     context: gitHubContext,
 });
 
-const git = require('../git');
+const git = require('../src/git');
 const ok: (x: any) => asserts x = A.ok;
 const userArgs = ['-c', 'user.name=github-action-benchmark', '-c', '[email protected]'];
 

index.ts src/index.ts

@@ -4,9 +4,9 @@ import { promises as fs } from 'fs';
 import * as cheerio from 'cheerio';
 import markdownit = require('markdown-it');
 import mock = require('mock-require');
-import { Config } from '../config';
-import { Benchmark } from '../extract';
-import { DataJson } from '../write';
+import { Config } from '../src/config';
+import { Benchmark } from '../src/extract';
+import { DataJson } from '../src/write';
 
 const ok: (x: any, msg?: string) => asserts x = assertOk;
 
@@ -79,7 +79,7 @@ mock('@actions/core', {
 mock('@actions/github', { context: gitHubContext });
 mock('@octokit/rest', FakedOctokit);
 
-const writeBenchmark: (b: Benchmark, c: Config) => Promise<any> = require('../write').writeBenchmark;
+const writeBenchmark: (b: Benchmark, c: Config) => Promise<any> = require('../src/write').writeBenchmark;
 
 describe('writeBenchmark()', function() {
     const savedCwd = process.cwd();

octokit_graphql.d.ts src/octokit_graphql.d.ts

@@ -20,18 +20,18 @@
     "resolveJsonModule": true
   },
   "files": [
-    "index.ts",
-    "config.ts",
-    "test/config.ts",
-    "extract.ts",
+    "src/index.ts",
+    "src/config.ts",
+    "src/extract.ts",
+    "src/git.ts",
+    "src/write.ts",
+    "src/default_index_html.ts",
+    "src/octokit_graphql.d.ts",
     "test/extract.ts",
-    "git.ts",
+    "test/config.ts",
     "test/git.ts",
-    "write.ts",
     "test/write.ts",
-    "default_index_html.ts",
     "test/default_index_html.ts",
-    "octokit_graphql.d.ts",
     "scripts/ci_validate_modification.ts"
   ]
 }