From 0a4f2c2c57126598c873951c0ffaf49a3515740d Mon Sep 17 00:00:00 2001 From: Chris Date: Fri, 20 Dec 2024 18:47:06 +0100 Subject: [PATCH] chore: several adjustments --- .vscode/dictionary.txt | 6 ++++++ README.md | 14 +++++++------- docs/.vitepress/config.ts | 2 +- docs/index.md | 4 ++-- docs/install.md | 2 +- docs/intro.md | 2 +- docs/usage.md | 4 ++-- eslint.config.js => eslint.config.ts | 8 ++++---- package.json | 6 +++--- test/spreadsheets.test.ts | 2 +- 10 files changed, 28 insertions(+), 22 deletions(-) rename eslint.config.js => eslint.config.ts (56%) diff --git a/.vscode/dictionary.txt b/.vscode/dictionary.txt index 204415a..311d451 100644 --- a/.vscode/dictionary.txt +++ b/.vscode/dictionary.txt @@ -10,11 +10,14 @@ commitlint commitlintrc composables davidanson +dbaeumer degit deps destructurable +dtsx entrypoints heroicons +iconify lockb openweb outdir @@ -23,11 +26,14 @@ Postcardware prefetch preinstall quickfix +shikijs socio Solana Spatie stacksjs +twoslash typecheck +unocss unplugin unref upath diff --git a/README.md b/README.md index 588b72d..3227f48 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

Social Card of this Bun Spreadsheets repo

+

Social Card of this Bun Spreadsheets repo

[![npm version][npm-version-src]][npm-version-href] [![GitHub Actions][github-actions-src]][github-actions-href] @@ -24,13 +24,13 @@ Easily generate spreadsheets, like CSVs and Excel files. ## ๐Ÿค– Usage ```bash -bun install bun-spreadsheets +bun install ts-spreadsheets ``` Now, you can use it in your project: ```ts -import { createSpreadsheet, spreadsheet } from 'bun-spreadsheets' +import { createSpreadsheet, spreadsheet } from 'ts-spreadsheets' // Create a spreadsheet const data = { @@ -187,7 +187,7 @@ await spreadsheet(data).store('output.xlsx') await spreadsheet(data).generateExcel().store('output.xlsx') ``` -To view the full documentation, please visit [https://stacksjs.org/docs/bun-spreadsheets](https://stacksjs.org/docs/bun-spreadsheets). +To view the full documentation, please visit [https://stacksjs.org/docs/ts-spreadsheets](https://stacksjs.org/docs/ts-spreadsheets). ## ๐Ÿงช Testing @@ -222,13 +222,13 @@ Many thanks to the following core technologies & people who have contributed to ## ๐Ÿ“„ License -The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/bun-spreadsheets/tree/main/LICENSE.md) for more information. +The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/ts-spreadsheets/tree/main/LICENSE.md) for more information. Made with ๐Ÿ’™ -[npm-version-src]: https://img.shields.io/npm/v/bun-spreadsheets?style=flat-square -[npm-version-href]: https://npmjs.com/package/bun-spreadsheets +[npm-version-src]: https://img.shields.io/npm/v/ts-spreadsheets?style=flat-square +[npm-version-href]: https://npmjs.com/package/ts-spreadsheets [github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/ts-starter/ci.yml?style=flat-square&branch=main [github-actions-href]: https://github.com/stacksjs/ts-starter/actions?query=workflow%3Aci diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index b5576b5..a600103 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -62,7 +62,7 @@ export default withPwa( defineConfig({ lang: 'en-US', title: 'ts-spreadsheets', - description: 'Easily generate spreadsheets, like CSVs and Excel files.', + description: 'Easily manage spreadsheets. CSV & Excel.', metaChunk: true, cleanUrls: true, diff --git a/docs/index.md b/docs/index.md index fc3b4b5..e42f099 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,8 +3,8 @@ layout: home hero: name: "ts-spreadsheets" - text: "A typescript spreadsheet Library" - tagline: "Easily generate spreadsheets, like CSVs and Excel files." + text: "A TypeScript Spreadsheet Library" + tagline: "Easily manage spreadsheets. CSVs & Excel." image: /images/logo-white.png actions: - theme: brand diff --git a/docs/install.md b/docs/install.md index 472d2a9..abf0e8b 100644 --- a/docs/install.md +++ b/docs/install.md @@ -3,7 +3,7 @@ ## Bun ```bash -bun install bun-spreadsheets +bun install ts-spreadsheets ``` _We are looking to publish this package npm under the name `ts-spreadsheets`. We are also hoping npm will release the name for us._ diff --git a/docs/intro.md b/docs/intro.md index c9d6ec7..bc32e5b 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -42,7 +42,7 @@ Many thanks to the following core technologies & people who have contributed to ## ๐Ÿ“„ License -The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/bun-spreadsheets/tree/main/LICENSE.md) for more information. +The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/ts-spreadsheets/tree/main/LICENSE.md) for more information. Made with ๐Ÿ’™ diff --git a/docs/usage.md b/docs/usage.md index e2dba52..52e3818 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -3,7 +3,7 @@ Now, you can use it in your project: ```ts -import { createSpreadsheet, spreadsheet } from 'bun-spreadsheets' +import { createSpreadsheet, spreadsheet } from 'ts-spreadsheets' // Create a spreadsheet const data = { @@ -160,4 +160,4 @@ await spreadsheet(data).store('output.xlsx') await spreadsheet(data).generateExcel().store('output.xlsx') ``` -To view the full documentation, please visit [https://stacksjs.org/docs/bun-spreadsheets](https://stacksjs.org/docs/bun-spreadsheets). +To view the full documentation, please visit [https://stacksjs.org/docs/ts-spreadsheets](https://stacksjs.org/docs/ts-spreadsheets). diff --git a/eslint.config.js b/eslint.config.ts similarity index 56% rename from eslint.config.js rename to eslint.config.ts index d24b632..4a3b1b8 100644 --- a/eslint.config.js +++ b/eslint.config.ts @@ -1,6 +1,7 @@ +import type { ESLintConfig } from '@stacksjs/eslint-config' import stacks from '@stacksjs/eslint-config' -export default stacks({ +const config: ESLintConfig = stacks({ stylistic: { indent: 2, quotes: 'single', @@ -9,7 +10,6 @@ export default stacks({ typescript: true, jsonc: true, yaml: true, - ignores: [ - 'fixtures/**', - ], }) + +export default config diff --git a/package.json b/package.json index 55914c4..7f62cbf 100644 --- a/package.json +++ b/package.json @@ -5,13 +5,13 @@ "description": "Easily generate spreadsheets, like CSVs and Excel files.", "author": "Chris Breuer ", "license": "MIT", - "homepage": "https://github.com/stacksjs/bun-spreadsheets#readme", + "homepage": "https://github.com/stacksjs/ts-spreadsheets#readme", "repository": { "type": "git", - "url": "git+https://github.com/stacksjs/bun-spreadsheets.git" + "url": "git+https://github.com/stacksjs/ts-spreadsheets.git" }, "bugs": { - "url": "https://github.com/stacksjs/bun-spreadsheets/issues" + "url": "https://github.com/stacksjs/ts-spreadsheets/issues" }, "keywords": [ "spreadsheet", diff --git a/test/spreadsheets.test.ts b/test/spreadsheets.test.ts index 6710706..eb9f122 100644 --- a/test/spreadsheets.test.ts +++ b/test/spreadsheets.test.ts @@ -3,7 +3,7 @@ import { afterEach, beforeEach, describe, expect, it } from 'bun:test' import { existsSync, unlinkSync } from 'node:fs' import { createSpreadsheet, spreadsheet } from '../src/index' -describe('bun-spreadsheets', () => { +describe('ts-spreadsheets', () => { let testData: Content beforeEach(() => {