Skip to content

Commit a73c171

Browse files
ilg-ulilg-ul
committed
re-generate top commons
1 parent 93eef81 commit a73c171

8 files changed

Lines changed: 214 additions & 101 deletions

File tree

‎.github/copilot-instructions.md‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,34 @@
1212
- Maintain consistency in terminology throughout the codebase
1313
- Prefer "folder" to "directory"
1414

15-
## Code Style
15+
## TypeScript Code Style
1616

17-
- Follow the existing ESlint TypeScript conventions in this project (`typescript-eslint` rules)
17+
- Follow the existing ESlint TypeScript conventions (the rules defined by the `typescript-eslint` and `prettier` projects)
1818
- Use consistent formatting and naming conventions based on prettier and ESLint configurations
1919

20+
## Documentation
21+
22+
- Add comprehensive TSDoc comments accepted by API Extractor
23+
- Document all classes, methods, properties, parameters, and return types
24+
- Document private and protected members as well
25+
- Keep the line length below 80 characters
26+
- If the code already includes documentation, review and possibly improve it
27+
- Preserve the `// eslint-disable-next-line` comments when present
28+
- Use `@remarks` for additional detailed notes or explanations within TSDoc comments; this should be placed after the summary and before any tags
29+
- Use `@param` and `@returns` tags appropriately in TSDoc comments; place `@param` tags immediately after the summary and before `@returns`
30+
- Use `@throws {@link ExceptionName}` for exceptions and place the descriptions on the next line; place these tags after `@returns`
31+
- Precede `@throws` tags with an empty line, and place the description on the next line
32+
- Do not documnent exceptions thrown by assertions
33+
- Do not add `@public` or `@internal` tags
34+
- When generating lists in TSDoc `@remarks` comments, use html `<ol>` and `<li>` tags for ordered lists, and `<ul>` and `<li>` tags for unordered lists.
35+
- inside html lists, do not use markdown syntax for bold or italics, use `<b>`, `<i>` html tags instead
36+
- inside html lists, do not use markdown syntax for code, use `<code>` html tags instead
37+
- inside html lists, do not use `{@link name}` syntax for links, use `<code>` html tags instead
38+
- outside of html lists, use markdown syntax for code (`code`) and links (`{@link name}`)
39+
- In the `@remarks` section, first explain why the method or property is useful, then explain how to use it, and finally provide any additional notes or details.
40+
41+
## Folder Structure
42+
43+
- `/src`: Contains the TypeScript source code
44+
- `/tests`: Contains the test suites and test cases
45+
- `/templates`: Contains any template files used for code generation or project scaffolding

‎.github/workflows/publish-github-pages.yml‎

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
# This file is part of the xPack project (http://xpack.github.io).
66
# Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.
77
#
8-
# Permission to use, copy, modify, and/or distribute this software
9-
# for any purpose is hereby granted, under the terms of the MIT license.
8+
# Permission to use, copy, modify, and/or distribute this software for any
9+
# purpose is hereby granted, under the terms of the MIT license.
1010
#
11-
# If a copy of the license was not distributed with this file, it can
12-
# be obtained from https://opensource.org/licenses/mit.
11+
# If a copy of the license was not distributed with this file, it can be
12+
# obtained from https://opensource.org/licenses/mit.
1313
#
1414
# -----------------------------------------------------------------------------
1515

@@ -34,7 +34,6 @@ on:
3434
# ... any of these files changes ...
3535
paths:
3636
- 'website/**'
37-
- 'typedoc.json'
3837
- '**/tsconfig*.json'
3938
- 'src/**/*.ts'
4039
- 'README.md'
@@ -53,17 +52,16 @@ permissions:
5352
# Allow one concurrent deployment.
5453
# https://docs.github.com/en/actions/using-jobs/using-concurrency
5554
concurrency:
56-
group: "pages"
55+
group: 'pages'
5756
cancel-in-progress: true
5857

5958
jobs:
6059
# Single deploy job since we're just deploying.
61-
# https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#standard-github-hosted-runners-for-public-repositories
6260
deploy:
6361
environment:
6462
name: github-pages
6563
url: ${{steps.deployment.outputs.page_url}}
66-
# https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources
64+
# https://github.com/actions/runner-images
6765
runs-on: ubuntu-24.04
6866

6967
steps:
@@ -76,31 +74,31 @@ jobs:
7674

7775
- name: Use Nodejs
7876
# https://github.com/actions/setup-node
79-
uses: actions/setup-node@v6.2.0
77+
uses: actions/setup-node@v6.4.0
8078
with:
8179
# Node LTS version.
82-
node-version: 20
80+
node-version: 24
8381

8482
- name: Install dependencies
85-
run: (cd website; npm ci)
83+
run: npm --prefix website ci
8684

8785
- name: Build the Docusaurus site
88-
run: (cd website; npm run build)
86+
run: npm --prefix website run build
8987

9088
- name: Setup Pages
9189
# https://github.com/actions/configure-pages
92-
uses: actions/configure-pages@v5.0.0
90+
uses: actions/configure-pages@v6.0.0
9391

9492
- name: Upload Pages artifact
9593
# https://github.com/actions/upload-pages-artifact
96-
uses: actions/upload-pages-artifact@v4.0.0
94+
uses: actions/upload-pages-artifact@v5.0.0
9795
with:
98-
# Upload entire repository
96+
# Upload entire website
9997
path: './website/build'
10098

10199
- name: Deploy to GitHub Pages
102100
id: deployment # referred by environment above, to get the URL.
103101
# https://github.com/actions/deploy-pages
104-
uses: actions/deploy-pages@v4.0.5
102+
uses: actions/deploy-pages@v5.0.0
105103
with:
106104
artifact_name: github-pages

‎.github/workflows/trigger-publish-github-pages-preview.yml‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,21 @@
55
# This file is part of the xPack project (http://xpack.github.io).
66
# Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.
77
#
8-
# Permission to use, copy, modify, and/or distribute this software
9-
# for any purpose is hereby granted, under the terms of the MIT license.
8+
# Permission to use, copy, modify, and/or distribute this software for any
9+
# purpose is hereby granted, under the terms of the MIT license.
1010
#
11-
# If a copy of the license was not distributed with this file, it can
12-
# be obtained from https://opensource.org/licenses/mit.
11+
# If a copy of the license was not distributed with this file, it can be
12+
# obtained from https://opensource.org/licenses/mit.
1313
#
1414
# -----------------------------------------------------------------------------
1515

1616
# Simple workflow to trigger the deployment of GitHub Pages in another project
17-
name: Trigger Remote GitHub Pages
17+
18+
# -----------------------------------------------------------------------------
19+
20+
# https://xpack.github.io/
21+
# https://github.com/xpack/xpack.github.io/actions/workflows/trigger-publish-github-pages-preview.yml
22+
name: Trigger Remote GitHub Pages Preview
1823

1924
on:
2025
# Runs on pushes, if all conditions are met:
@@ -44,9 +49,9 @@ permissions:
4449
pages: write
4550
id-token: write
4651

47-
# Allow one concurrent deployment
52+
# Allow one concurrent deployment.
4853
concurrency:
49-
group: "pages"
54+
group: 'pages'
5055
cancel-in-progress: true
5156

5257
jobs:

‎.gitignore‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# -----------------------------------------------------------------------------
2+
# DO NOT EDIT!
3+
# Automatically generated from npm-packages-helper/templates/*.
4+
# -----------------------------------------------------------------------------
5+
16
# Logs
27
logs
38
*.log
@@ -89,7 +94,7 @@ out
8994

9095
# Nuxt.js build / generate output
9196
.nuxt
92-
dist
97+
# dist
9398

9499
# Gatsby files
95100
.cache/

‎.vscode/settings.json‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"editor.rulers": [
3+
80
4+
],
5+
"editor.detectIndentation": false,
6+
"editor.insertSpaces": true,
7+
"editor.tabSize": 2,
8+
"editor.formatOnSave": true,
9+
"[javascript]": {
10+
"editor.defaultFormatter": "esbenp.prettier-vscode"
11+
},
12+
"[typescript]": {
13+
"editor.defaultFormatter": "esbenp.prettier-vscode"
14+
},
15+
"[liquid]": {
16+
"editor.formatOnSave": false,
17+
"editor.formatOnType": false,
18+
"editor.formatOnPaste": false,
19+
"editor.defaultFormatter": null
20+
},
21+
"files.associations": {
22+
"*.json": "jsonc",
23+
"*-liquid.*": "liquid",
24+
"*.liquid": "liquid"
25+
},
26+
"cSpell.language": "en-GB",
27+
"cSpell.ignoreWords": [],
28+
"prettier.configPath": "config/.prettierrc.json",
29+
"prettier.ignorePath": "config/.prettierignore",
30+
"markdownlint.config": {
31+
"MD041": false
32+
},
33+
"cmake.ignoreCMakeListsMissing": true,
34+
"cmake.configureOnOpen": false,
35+
"makefile.configureOnOpen": false,
36+
"npm.exclude": [
37+
"**/xpacks/**",
38+
"**/build/**",
39+
"**/tests/**",
40+
"**/tmp/**"
41+
],
42+
"xpack.exclude": [
43+
"**/xpacks/**",
44+
"**/build/**",
45+
"**/tests/**",
46+
"**/tmp/**"
47+
]
48+
}

‎config/top-templates.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"descriptiveName": "xPack Project",
3+
"preferredName": "xPack Project",
4+
"hasEmptyMaster": true,
5+
"hasTriggerPublishPreview": true,
6+
"isOrganisationWeb": true,
7+
"hasWebsite": true
8+
}

0 commit comments

Comments
 (0)