Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
LuckyYam committed Jul 27, 2022
0 parents commit c472463
Show file tree
Hide file tree
Showing 12 changed files with 1,221 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
dist
docs
10 changes: 10 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"root": true,
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint"],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended"
]
}
41 changes: 41 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Docs workflow

on:
push:
branches:
- master
jobs:
Build:
runs-on: ubuntu-latest
outputs:
package-name: ${{ steps.packageInfo.outputs.package-name }}
package-version: ${{ steps.packageInfo.outputs.package-version }}
commit-msg: ${{ steps.packageInfo.outputs.commit-msg }}
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- name: Checkout Commit
uses: actions/checkout@v2

- name: Parsing Package Info
id: packageInfo
run: |
echo "::set-output name=package-name::$(jq -r .name package.json)"
echo "::set-output name=package-version::$(jq -r .version package.json)"
echo "::set-output name=commit-msg::$(git log -1 --pretty=%B)"
- name: Setup Node.js environment
uses: actions/[email protected]

- name: Install Dependencies
run: yarn install

- name: Docs Build
run: yarn docs

- name: Publish to Pages
uses: crazy-max/ghaction-github-pages@v2
with:
target_branch: gh-pages
build_dir: docs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
docs
dist
7 changes: 7 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"semi": false,
"trailingComma": "none",
"singleQuote": true,
"printWidth": 80,
"tabWidth": 4
}
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Lucky Yambem

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
In progress...
48 changes: 48 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"name": "nhentai.ts",
"description": "A scraper for NHentai with built-in types",
"version": "0.0.0",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
"license": "MIT",
"keywords": [
"nhentai",
"doujin"
],
"files": [
"dist"
],
"repository": {
"type": "git",
"url": "https://github.com/LuckyYam/nhentai.ts.git"
},
"bugs": {
"url": "https://github.com/LuckyYam/nhentai.ts/issues"
},
"homepage": "https://github.com/LuckyYam/nhentai.ts#readme",
"author": {
"name": "Lucky Yambem",
"url": "https://github.com/LuckyYam"
},
"scripts": {
"build": "yarn rimraf dist && yarn tsc",
"lint": "yarn eslint .",
"format": "yarn prettier --write --config .prettierrc.json \"src/**/*.ts\"",
"lint:fix": "yarn eslint --fix .",
"prepack": "yarn build",
"docs": "yarn typedoc"
},
"dependencies": {
"axios": "^0.27.2",
"cheerio": "^1.0.0-rc.12"
},
"devDependencies": {
"@types/node": "^18.6.1",
"@typescript-eslint/eslint-plugin": "^5.31.0",
"@typescript-eslint/parser": "^5.31.0",
"eslint": "^8.20.0",
"prettier": "^2.7.1",
"typedoc": "^0.23.9",
"typescript": "^4.7.4"
}
}
1 change: 1 addition & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export default 'nhentai.ts'
16 changes: 16 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"compilerOptions": {
"target": "es6",
"module": "commonjs",
"declaration": true,
"outDir": "./dist",
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"strict": true,
"noImplicitAny": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
"noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
}
}
8 changes: 8 additions & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"entryPoints": ["./src/index.ts"],
"excludePrivate": true,
"excludeProtected": true,
"excludeExternals": true,
"includeVersion": false,
"entryPointStrategy": "expand"
}
Loading

0 comments on commit c472463

Please sign in to comment.