Skip to content

Commit d12658a

Browse files
author
m.r
committed
add comment to interface and main func & update readme
1 parent be52121 commit d12658a

27 files changed

+1273
-119
lines changed

‎.github/workflows/manually-npm-publish-github-packages.yaml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
2+
# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
3+
4+
name: Manually Publish Github Package
5+
6+
# on:
7+
# release:
8+
# types: [created]
9+
# name: Manually Test
10+
on:
11+
workflow_dispatch
12+
# inputs:
13+
# branch:
14+
# description: 'Branch for Publish'
15+
# required: true
16+
# default: 'main'
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
- uses: actions/setup-node@v4
24+
with:
25+
node-version: 20
26+
- run: npm ci
27+
- run: npm test
28+
29+
publish-gpr:
30+
needs: build
31+
runs-on: ubuntu-latest
32+
permissions:
33+
contents: read
34+
packages: write
35+
steps:
36+
- uses: actions/checkout@v4
37+
- uses: actions/setup-node@v4
38+
with:
39+
node-version: 20
40+
registry-url: https://npm.pkg.github.com/
41+
- run: npm ci
42+
- run: npm publish
43+
env:
44+
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

‎.github/workflows/manually-release-publish.yml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: Manually Release & Publish Package
2+
on:
3+
workflow_dispatch
4+
# push:
5+
# branches:
6+
# - main
7+
# paths:
8+
# - CHANGELOG.md
9+
# pull_request:
10+
# branches:
11+
# - main
12+
# paths:
13+
# - CHANGELOG.md
14+
jobs:
15+
release:
16+
name: Create release package
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Checkout to code
20+
uses: actions/checkout@v4
21+
- name: install Node js Version 20.x
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: '20.x'
25+
- name: Retrieve Release Version
26+
run: echo "PV=$(node version.js)" >> $GITHUB_ENV
27+
- run: cat change-log
28+
- name: Retrieve Release Body
29+
run: |
30+
{
31+
echo 'PB<<EOF'
32+
cat change-log
33+
echo EOF
34+
} >> $GITHUB_ENV
35+
- run: echo ${{env.PV}}
36+
- name: Create Github Release
37+
uses: actions/create-release@v1
38+
env:
39+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
40+
with:
41+
tag_name: ${{env.PV}}
42+
release_name: Release v${{env.PV}}
43+
body: ${{env.PB}}
44+
publish-gpr:
45+
needs: build
46+
runs-on: ubuntu-latest
47+
permissions:
48+
contents: read
49+
packages: write
50+
steps:
51+
- uses: actions/checkout@v4
52+
- uses: actions/setup-node@v4
53+
with:
54+
node-version: 20
55+
registry-url: https://npm.pkg.github.com/
56+
- run: npm ci
57+
- run: npm publish
58+
env:
59+
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
60+
publish:
61+
name: Publish to NPM
62+
needs: release
63+
runs-on: ubuntu-latest
64+
steps:
65+
- name: Checkout to code
66+
uses: actions/checkout@v4
67+
- name: install Node js Version 20.x
68+
uses: actions/setup-node@v4
69+
with:
70+
node-version: '20.x'
71+
registry-url: 'https://registry.npmjs.org'
72+
- run: npm ci
73+
- name: publish to npm
74+
run: npm publish
75+
env:
76+
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

‎.github/workflows/manually_test.yml renamed to ‎.github/workflows/manually-test.yml

File renamed without changes.

‎.github/workflows/release.yml

Lines changed: 0 additions & 61 deletions
This file was deleted.

‎CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Changelog
22

3+
## Version 7.0.0 (2025-02-16)
4+
5+
### New Features
6+
7+
- A drop-down option (multi-select option) provides the ability to create a cell that contains multiple selectable values.`sheet`->`[n]`->`dropDowns`
8+
- The `replaceInExcel` functionality in Excel allows you to replace data in an existing file using flags provided within the spreadsheet.
9+
10+
### Bug Fixes
11+
12+
- `generateExcel` supports empty objects and will generate an empty Excel file.
13+
14+
> [!NOTE]
15+
> The related interface has not changed, so the sheet needs to be provided in TypeScript.
16+
17+
### Improvements
18+
19+
- Begin adding JSDoc comments to the main functions and interfaces.
20+
21+
322
## Version 6.0.1 (2024-08-11)
423

524
### New Features

‎README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,18 @@ important functions of library that are defined with specific use cases as follo
4242

4343
<a id="replace-in-excel"></a>
4444

45-
- **`replaceInExcel`**: This function is used to replace data based on a defined flag, such as {{FLAG}}, in Excel.
45+
- **`🆕replaceInExcel`**: This function is used to replace data based on a defined flag, such as {{FLAG}}, in Excel.
4646

4747
The example has been moved to a separate repository for easier updates. You can find it in the ["**_`mr-excel-example-gallery`_**"](https://github.com/mohammadrezaeicode/mr-excel-example-gallery)([**_link_**](https://github.com/mohammadrezaeicode/mr-excel-example-gallery))
4848

49+
## Related Projects
50+
51+
The following list includes new repositories related to this project. Documentation and improvements for these projects can be found in the repositories below.
52+
53+
- **`MR Excel Java`**:A similar project using Java is in development. The release version is coming soon; currently, it is available as a snapshot version.["`repository`"](https://github.com/mohammadrezaeicode/mr-excel-java)
54+
55+
- **`MR Excel Editor`**: An editor that utilizes the library is currently under development. At present, it only generates simple results.["`repository`"](https:///github.com/mohammadrezaeicode/mr-excel-editor)["`Demo`"](https://mohammadrezaeicode.github.io/mr-excel-editor/)
56+
4957
## Table of Contents
5058

5159
<a id="table-of-contents"></a>
@@ -471,7 +479,7 @@ ExcelTable.themeBaseGenerate(data, { negativeColor: true });
471479

472480
</details>
473481

474-
[More Example](example/CDN/themeBaseGenerate)
482+
[More Example](https://github.com/mohammadrezaeicode/mr-excel-example-gallery/blob/main/CDN/themeBaseGenerate)
475483

476484
<a id="convert-table-to-excel-usage"></a>
477485

@@ -498,9 +506,9 @@ ExcelTable.convertTableToExcel("#table", null, {
498506

499507
<details>
500508

501-
<summary>result of Example in https://github.com/mohammadrezaeicode/mr-excel-repo/blob/main/example/conv1.html</summary>
509+
<summary>result of Example in https://github.com/mohammadrezaeicode/mr-excel-example-gallery/blob/main/conv1.html</summary>
502510

503-
![ex](./example/ex13.PNG)
511+
![ex](https://github.com/mohammadrezaeicode/mr-excel-example-gallery/blob/main/ex13.PNG)
504512

505513
</details>
506514

@@ -853,7 +861,7 @@ ExcelTable.sideBySideLineByLine(sideData);
853861

854862
</details>
855863

856-
[More Example](example/CDN/sideBySideLineByLine)
864+
[More Example](https://github.com/mohammadrezaeicode/mr-excel-example-gallery/tree/main/CDN/sideBySideLineByLine)
857865

858866
<a id="generate-excel-usage"></a>
859867

@@ -1018,7 +1026,7 @@ ExcelTable.generateExcel(data);
10181026

10191027
</details>
10201028

1021-
[More Example](example/CDN/generateExcel)
1029+
[More Example](https://github.com/mohammadrezaeicode/mr-excel-example-gallery/blob/main/CDN/generateExcel)
10221030

10231031
<a id="general-option"></a>
10241032

@@ -7281,6 +7289,8 @@ To migrate from Version 2 to Version 3, you need to follow the steps below:
72817289

72827290
## Release Notes [⬆️](#table-of-contents)
72837291

7292+
### Version 7.0.0 (2025-02-16)
7293+
72847294
#### New Features
72857295

72867296
- A drop-down option (multi-select option) provides the ability to create a cell that contains multiple selectable values.`sheet`->`[n]`->`dropDowns`
@@ -7293,6 +7303,10 @@ To migrate from Version 2 to Version 3, you need to follow the steps below:
72937303
> [!NOTE]
72947304
> The related interface has not changed, so the sheet needs to be provided in TypeScript.
72957305
7306+
#### Improvements
7307+
7308+
- Begin adding JSDoc comments to the main functions and interfaces.
7309+
72967310
### Version 6.0.1 (2024-08-11)
72977311

72987312
#### New Features

‎change-log

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
## Version 6.0.1 (2024-08-11)
1+
## Version 7.0.0 (2025-02-16)
22

33
### New Features
44

5-
- Introduced formatMap to support new data formats.
6-
- Added the excelToJson and excelToNode functions.
5+
- A drop-down option (multi-select option) provides the ability to create a cell that contains multiple selectable values.`sheet`->`[n]`->`dropDowns`
6+
- The `replaceInExcel` functionality in Excel allows you to replace data in an existing file using flags provided within the spreadsheet.
7+
8+
### Bug Fixes
9+
10+
- `generateExcel` supports empty objects and will generate an empty Excel file.
11+
12+
> [!NOTE]
13+
> The related interface has not changed, so the sheet needs to be provided in TypeScript.
714

815
### Improvements
916

10-
- Increased code coverage to 90%.
11-
- Enhanced capability to use image, checkbox, and comment together.
12-
- Incorporated GitHub Community Standards for better collaboration.
13-
- more
17+
- Begin adding JSDoc comments to the main functions and interfaces.
1418

15-
### Bug Fixes
1619

17-
- Resolved issues related to backgroundImage.
18-
- Resolved an issue related to the incorrect package release in version 6.0.0.

‎dist/excel-table.amd.js

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

‎dist/excel-table.cjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-xyzS9dVO.cjs");exports.Validator=e.validateExcelTable;exports.addGlobalOptionFromExcelTable=e.addGlobalOptionFromExcelTable;exports.addGlobalOptions=e.addGlobalOptions;exports.convertTableToExcel=e.convertTableToExcel;exports.excelToJson=e.excelToJson;exports.excelToNode=e.excelToNode;exports.extractExcelData=e.extractExcelData;exports.generateCSV=e.generateCSV;exports.generateExcel=e.generateExcel;exports.generateText=e.generateText;exports.replaceInExcel=e.replaceInExcel;exports.sideBySideLineByLine=e.sideBySideLineByLine;exports.themeBaseGenerate=e.themeBaseGenerate;
1+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-CzrjgJVS.cjs");exports.Validator=e.validateExcelTable;exports.addGlobalOptionFromExcelTable=e.addGlobalOptionFromExcelTable;exports.addGlobalOptions=e.addGlobalOptions;exports.convertTableToExcel=e.convertTableToExcel;exports.excelToJson=e.excelToJson;exports.excelToNode=e.excelToNode;exports.extractExcelData=e.extractExcelData;exports.generateCSV=e.generateCSV;exports.generateExcel=e.generateExcel;exports.generateText=e.generateText;exports.replaceInExcel=e.replaceInExcel;exports.sideBySideLineByLine=e.sideBySideLineByLine;exports.themeBaseGenerate=e.themeBaseGenerate;

0 commit comments

Comments
 (0)