Skip to content

Commit bda9b53

Browse files
coderyicoderyi
committed
update
1 parent c5eb92e commit bda9b53

10 files changed

Lines changed: 101 additions & 111 deletions

File tree

‎.eslintignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist/*

‎.gitattributes‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist/** -diff

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
package-lock.json
22
node_modules/
33
yarn.lock
4+
dist/index.test.*
5+
dist/tsconfig.tsbuildinfo

‎.prettierignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist

‎.prettierrc.js‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
module.exports = {
2+
trailingComma: 'all',
3+
tabWidth: 2,
4+
semi: true,
5+
singleQuote: true,
6+
quoteProps: 'consistent',
7+
};

‎dist/index.d.ts‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
export interface IMonkeyGitHubUser {
2+
title: string;
3+
avatar_url: string;
4+
}
5+
export interface IMonkeyGitHubRepository {
6+
title: string;
7+
avatar_url: string;
8+
description: string;
9+
created_at: string;
10+
stargazers_count: number;
11+
forks_count: number;
12+
}
13+
export declare class MonkeyGitHubAPI {
14+
readonly searchUsers: (start: number, page: number, location: string, language: string) => Promise<IMonkeyGitHubUser[]>;
15+
readonly searchRepositories: (start: number, page: number, language: string) => Promise<IMonkeyGitHubRepository[]>;
16+
}

‎dist/index.js‎

Lines changed: 47 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/index.js.map‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
{
22
"name": "monkey-github-api",
3-
"version": "1.0.1",
4-
"description": "",
5-
"main": "index.js",
3+
"version": "1.0.3",
4+
"main": "dist/index.js",
5+
"types": "dist/index.d.ts",
6+
"license": "MIT",
7+
"dependencies": {},
8+
"devDependencies": {
9+
"prettier": "^2.0.1",
10+
"ts-node": "^10.3.1",
11+
"typescript": "^4.1.3"
12+
},
613
"scripts": {
7-
"start": "tsc && node ./src/index.js",
814
"build": "tsc",
9-
"test": "echo \"Error: no test specified\" && exit 1"
15+
"test": "ts-node -T src/index.test.ts"
1016
},
1117
"repository": {
1218
"url": "https://github.com/coderyi/monkey-github-api.git",
1319
"type": "git"
1420
},
15-
"author": "coderyi",
16-
"license": "MIT",
17-
"devDependencies": {
18-
"@types/node": "^16.11.11",
19-
"typescript": "^4.5.2"
20-
}
21+
"author": "coderyi"
22+
2123
}

‎tsconfig.json‎

Lines changed: 12 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,16 @@
11
{
22
"compilerOptions": {
3-
/* Visit https://aka.ms/tsconfig.json to read more about this file */
4-
5-
/* Projects */
6-
// "incremental": true, /* Enable incremental compilation */
7-
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8-
// "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
9-
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
10-
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11-
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12-
13-
/* Language and Environment */
14-
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
15-
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
16-
// "jsx": "preserve", /* Specify what JSX code is generated. */
17-
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18-
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19-
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
20-
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21-
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
22-
// "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
23-
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24-
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25-
26-
/* Modules */
27-
"module": "commonjs", /* Specify what module code is generated. */
28-
// "rootDir": "./", /* Specify the root folder within your source files. */
29-
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
30-
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
31-
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
32-
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
33-
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
34-
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
35-
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
36-
// "resolveJsonModule": true, /* Enable importing .json files */
37-
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
38-
39-
/* JavaScript Support */
40-
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
41-
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
42-
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
43-
44-
/* Emit */
45-
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
46-
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
47-
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
48-
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
49-
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
50-
// "outDir": "./", /* Specify an output folder for all emitted files. */
51-
// "removeComments": true, /* Disable emitting comments. */
52-
// "noEmit": true, /* Disable emitting files from a compilation. */
53-
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
54-
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
55-
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
56-
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
57-
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
58-
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
59-
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
60-
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
61-
// "newLine": "crlf", /* Set the newline character for emitting files. */
62-
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
63-
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
64-
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
65-
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
66-
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
67-
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
68-
69-
/* Interop Constraints */
70-
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
71-
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
72-
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
73-
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
74-
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
75-
76-
/* Type Checking */
77-
"strict": true, /* Enable all strict type-checking options. */
78-
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
79-
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
80-
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
81-
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
82-
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
83-
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
84-
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
85-
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
86-
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
87-
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
88-
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
89-
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
90-
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
91-
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
92-
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
93-
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
94-
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
95-
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
96-
97-
/* Completeness */
98-
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
99-
"skipLibCheck": true /* Skip type checking all .d.ts files. */
3+
"target": "ES2019",
4+
"module": "commonjs",
5+
"outDir": "dist",
6+
"allowJs": true,
7+
"declaration": true,
8+
"sourceMap": true,
9+
"incremental": true,
10+
"strict": true,
11+
"moduleResolution": "node",
12+
"esModuleInterop": true,
13+
"resolveJsonModule": true
10014
},
101-
"include": [
102-
"./src/**/*"
103-
]
15+
"include": ["src/*", "src/**/*"]
10416
}

0 commit comments

Comments
 (0)