Skip to content

Commit

Permalink
Add directory listing commands and update tsconfig and workflow
Browse files Browse the repository at this point in the history
Two `ls` commands have been added in src/index.ts for directory listing purposes. The "include" key has been added to tsconfig.json to specify which files to include in the TypeScript compilation. Workflow tsDoc.yml has been updated with additional steps, including 'npm install', 'npm run build', and changes in TSDoc Action parameters.
  • Loading branch information
erikyo committed Dec 12, 2023
1 parent b60fb83 commit 910d42a
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 101 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/tsDoc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,15 @@ jobs:
node-version: 16
cache: "npm"

- run: npm install

- name: TSDoc Action
uses: erikyo/tsdoc-action@v1
with:
source_dir: ./src
output_dir: ./docs
front_page: README.md
recurse: true
theme: typedoc-material-theme

- name: Setup Pages
uses: actions/configure-pages@v3
Expand Down
2 changes: 2 additions & 0 deletions lib/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

98 changes: 4 additions & 94 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 1 addition & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,7 @@
],
"dependencies": {
"@actions/core": "^1.10.1",
"@actions/exec": "^1.1.1",
"@typescript-eslint/eslint-plugin": "^6.14.0",
"@typescript-eslint/parser": "^6.14.0",
"typedoc": "^0.25.4"
"@actions/exec": "^1.1.1"
},
"devDependencies": {
"@types/node": "^18.19.3",
Expand Down
2 changes: 2 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ async function run(): Promise<string> {
/**
* Install typedoc
*/
await exec('ls', ['-la'])
await exec('ls', ['-la', GITHUB_WORKSPACE])
await exec('npm', ['i', 'typedoc'])

if (theme) {
Expand Down
6 changes: 4 additions & 2 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
"rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
"outDir": "./lib", /* Report errors in .js files. */
"noEmit": true,
"noEmit": true, /* Do not emit outputs. */
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
},
"exclude": ["./lib", "**/*.test.ts"]

"include": ["src/**/*"],
"exclude": ["lib", "**/*.test.ts"]
}

0 comments on commit 910d42a

Please sign in to comment.