Skip to content

Commit

Permalink
chore: several adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisbbreuer committed Dec 20, 2024
1 parent dfeb93c commit 0a4f2c2
Show file tree
Hide file tree
Showing 10 changed files with 28 additions and 22 deletions.
6 changes: 6 additions & 0 deletions .vscode/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ commitlint
commitlintrc
composables
davidanson
dbaeumer
degit
deps
destructurable
dtsx
entrypoints
heroicons
iconify
lockb
openweb
outdir
Expand All @@ -23,11 +26,14 @@ Postcardware
prefetch
preinstall
quickfix
shikijs
socio
Solana
Spatie
stacksjs
twoslash
typecheck
unocss
unplugin
unref
upath
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center"><img src="https://github.com/stacksjs/bun-spreadsheets/blob/main/.github/art/cover.jpg" alt="Social Card of this Bun Spreadsheets repo"></p>
<p align="center"><img src="https://github.com/stacksjs/ts-spreadsheets/blob/main/.github/art/cover.jpg" alt="Social Card of this Bun Spreadsheets repo"></p>

[![npm version][npm-version-src]][npm-version-href]
[![GitHub Actions][github-actions-src]][github-actions-href]
Expand All @@ -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 = {
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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 💙

<!-- Badges -->
[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

Expand Down
2 changes: 1 addition & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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._
Expand Down
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 💙

Expand Down
4 changes: 2 additions & 2 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down Expand Up @@ -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).
8 changes: 4 additions & 4 deletions eslint.config.js → eslint.config.ts
Original file line number Diff line number Diff line change
@@ -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',
Expand All @@ -9,7 +10,6 @@ export default stacks({
typescript: true,
jsonc: true,
yaml: true,
ignores: [
'fixtures/**',
],
})

export default config
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
"description": "Easily generate spreadsheets, like CSVs and Excel files.",
"author": "Chris Breuer <[email protected]>",
"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",
Expand Down
2 changes: 1 addition & 1 deletion test/spreadsheets.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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(() => {
Expand Down

0 comments on commit 0a4f2c2

Please sign in to comment.