Skip to content

Commit

Permalink
chore: configure repository (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
tasshi-me committed Jul 5, 2022
1 parent 8e0c4e3 commit f2b1f0c
Show file tree
Hide file tree
Showing 11 changed files with 5,246 additions and 24 deletions.
3 changes: 3 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ignore artifacts:
lib
coverage
18 changes: 18 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/** @type {import('eslint/lib/shared/types').ConfigData} */
const config = {
extends: "@cybozu/eslint-config/presets/node-typescript-prettier",
rules: {
curly: ["error", "all"],
"func-style": ["error"],
"@typescript-eslint/ban-types": [
"error",
{
types: {
object: false,
"{}": false,
},
},
],
},
};
module.exports = config;
24 changes: 24 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@

name: lint

on:
push:
branches:
- main
- 'renovate/**'
pull_request:

jobs:
lint:
name: Node.js ubuntu-latest 16.x
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js 16.x
uses: actions/setup-node@v3
with:
node-version: 16.x
cache: yarn
- run: yarn install --immutable
- run: yarn build
- run: yarn lint
32 changes: 32 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@

name: test

on:
push:
branches:
- main
- 'renovate/**'
pull_request:

jobs:
test:

name: Node.js ${{ matrix.os }} ${{ matrix.node-version }}
runs-on: ${{ matrix.os }}

strategy:
matrix:
node-version: [14.x, 16.x, 18.x]
os: [ubuntu-latest, windows-latest]

steps:
- run: git config --global core.autocrlf false
- uses: actions/checkout@v3
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
cache: yarn
- run: yarn install --immutable
- run: yarn build
- run: yarn test:ci
26 changes: 26 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
# dependencies
node_modules/
.node_modules/

# npm/yarn log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# testing
coverage/

# artifacts
lib
bin

# misc
**/.DS_Store
*.tsbuildinfo
attachments

# editor
**/.vs
**/.vscode
.idea

# secrets
.env
.envrc
9 changes: 9 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Ignore artifacts:
lib
coverage

# Ignore all HTML files:
*.html

# Ignore CHANGELOG.md (because it is auto generated)
CHANGELOG.md
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,4 +326,4 @@ If set `--attachments-dir` option, the format of Attachment field will be change

## LICENSE

- [MIT](https://github.com/kintone/js-sdk/blob/master/packages/data-loader/LICENSE)
- [MIT](https://github.com/kintone/cli-kintone/blob/main/LICENSE)
38 changes: 25 additions & 13 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,24 @@
},
"types": "lib/index.d.ts",
"scripts": {
"start": "yarn build --watch",
"prebuild": "yarn clean",
"build": "tsc --build --force",
"postbuild": "yarn pkg",
"lint": "run-p -l lint:*",
"pkg": "pkg . -o bin/kintone-data-loader -t linux,macos,win",
"test": "jest",
"test:ci": "jest --runInBand",
"clean": "rimraf lib bin",
"pkg": "pkg . -o bin/kintone-data-loader -t linux,macos,win",
"fix:lint": "yarn lint:eslint -- --fix",
"fix:md": "prettier --write README.md",
"lint": "run-p -l lint:*",
"lint:eslint": "eslint --ext .js,.mjs,.cjs,.ts,.mts,.cts ./",
"lint:md": "prettier --check ./**/*.md",
"fix": "run-p fix:*",
"lint:eslint": "eslint 'src/**/*.ts'",
"lint:md": "prettier --check README.md",
"start": "yarn build --watch"
"fix:lint": "run-s 'lint:eslint --fix'",
"fix:md": "run-s 'lint:md --write'",
"clean": "rimraf lib bin"
},
"repository": {
"type": "git",
"url": "git+https://github.com/kintone/js-sdk.git",
"directory": "packages/data-loader"
"url": "git+https://github.com/kintone/cli-kintone.git"
},
"files": [
"lib",
Expand All @@ -43,16 +42,29 @@
],
"license": "MIT",
"bugs": {
"url": "https://github.com/kintone/js-sdk/issues"
"url": "https://github.com/kintone/cli-kintone/issues"
},
"homepage": "https://github.com/kintone/js-sdk/tree/master/packages/data-loader#readme",
"homepage": "https://github.com/kintone/cli-kintone/#readme",
"engines": {
"node": ">=14"
},
"devDependencies": {
"@babel/core": "^7.18.6",
"@babel/preset-env": "^7.18.6",
"@babel/preset-typescript": "^7.18.6",
"@cybozu/eslint-config": "^17.0.2",
"@types/jest": "^28.1.4",
"@types/node": "^18.0.1",
"@types/yargs": "^17.0.10",
"babel-jest": "^28.1.2",
"cross-env": "^7.0.3",
"pkg": "^5.7.0"
"eslint": "^8.19.0",
"jest": "^28.1.2",
"npm-run-all": "^4.1.5",
"pkg": "^5.7.0",
"prettier": "^2.7.1",
"rimraf": "^3.0.2",
"typescript": "^4.7.4"
},
"dependencies": {
"@kintone/rest-api-client": "^3.1.4",
Expand Down
10 changes: 8 additions & 2 deletions src/types/kintone.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,14 @@ import {
KintoneFormFieldProperty,
KintoneRecordField,
} from "@kintone/rest-api-client";
import { UpdateKey } from "@kintone/rest-api-client/src/client/types/record";
import { RecordID, Revision } from "@kintone/rest-api-client/src/client/types";

export type RecordID = string | number;
export type Revision = string | number;

export type UpdateKey = {
field: string;
value: string | number;
};

export type CsvRow = Record<string, string>;
export type KintoneRecordForParameter = {
Expand Down
75 changes: 67 additions & 8 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,70 @@
{
"extends": "../tsconfig-base.json",
"compilerOptions": {
"lib": ["ES2019"],
"outDir": "./lib",
"rootDir": "./src"
},
"references": [
{ "path": "../rest-api-client" }
]
/* Visit https://aka.ms/tsconfig.json to read more about this file */

/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es2015", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
"lib": ["ES2019"], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
"declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
"sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./lib", /* Redirect output structure to the directory. */
"rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
"composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */

/* Module Resolution Options */
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */

/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */

/* Advanced Options */
"skipLibCheck": true, /* Skip type checking of declaration files. */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
}
}
Loading

0 comments on commit f2b1f0c

Please sign in to comment.