Skip to content

Commit b837671

Browse files
committed
feat(tsconfig): Initial check-in of the shared tsconfig package
1 parent f68cd80 commit b837671

12 files changed

Lines changed: 505 additions & 15 deletions

packages/tsconfig/README.md

Lines changed: 292 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,292 @@
1+
<!-- START header -->
2+
<!-- prettier-ignore-start -->
3+
<!-- markdownlint-disable -->
4+
5+
6+
<div align="center"><img src="https://public.storm-cdn.com/storm-banner.gif" width="100%" alt="Storm Stack" /></div>
7+
<br />
8+
9+
<div align="center">
10+
<b>
11+
<a href="https://stormsoftware.com" target="_blank">Website</a> •
12+
<a href="https://github.com/storm-software/storm-stack" target="_blank">GitHub</a> •
13+
<a href="https://discord.gg/MQ6YVzakM5">Discord</a> • <a href="https://stormstack.github.io/stormstack/" target="_blank">Docs</a> • <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> •
14+
<a href="https://github.com/storm-software/storm-stack/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a>
15+
</b>
16+
</div>
17+
18+
<br />
19+
This package is part of the ⚡<b>Storm Stack</b> monorepo. Storm Stack packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.
20+
<br />
21+
22+
<h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
23+
24+
[![Version](https://img.shields.io/badge/version-0.1.5-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-stack/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
25+
26+
<!-- prettier-ignore-start -->
27+
<!-- markdownlint-disable -->
28+
29+
> [!IMPORTANT]
30+
> This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be available through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
31+
32+
<!-- markdownlint-restore -->
33+
<!-- prettier-ignore-end -->
34+
35+
<div align="center">
36+
<b>Be sure to ⭐ this repository on <a href="https://github.com/storm-software/storm-stack" target="_blank">GitHub</a> so you can keep up to date on any daily progress!</b>
37+
</div>
38+
39+
<br />
40+
41+
<!-- markdownlint-restore -->
42+
<!-- prettier-ignore-end -->
43+
44+
<!-- END header -->
45+
46+
# Storm Stack - TypeScript Configuration (tsconfig.json)
47+
48+
A shared TypeScript configuration containing various tsconfig.json files used in Storm Stack projects.
49+
50+
<!-- START doctoc -->
51+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
52+
## Table of Contents
53+
54+
- [Storm Stack - TypeScript Configuration (tsconfig.json)](#storm-stack---typescript-configuration-tsconfigjson)
55+
- [Table of Contents](#table-of-contents)
56+
- [Installing](#installing)
57+
- [Reduced Package Size](#reduced-package-size)
58+
- [Development](#development)
59+
- [Building](#building)
60+
- [Running unit tests](#running-unit-tests)
61+
- [Linting](#linting)
62+
- [Storm Workspaces](#storm-workspaces)
63+
- [Roadmap](#roadmap)
64+
- [Support](#support)
65+
- [License](#license)
66+
- [Changelog](#changelog)
67+
- [Contributing](#contributing)
68+
- [Contributors](#contributors)
69+
70+
<!-- END doctoc -->
71+
72+
## Installing
73+
74+
Using [pnpm](http://pnpm.io):
75+
76+
```bash
77+
pnpm add -D @storm-stack/biome
78+
```
79+
80+
<details>
81+
<summary>Using npm</summary>
82+
83+
```bash
84+
npm install -D @storm-stack/biome
85+
```
86+
87+
</details>
88+
89+
<details>
90+
<summary>Using yarn</summary>
91+
92+
```bash
93+
yarn add -D @storm-stack/biome
94+
```
95+
96+
</details>
97+
98+
## Reduced Package Size
99+
100+
This project uses [tsup](https://tsup.egoist.dev/) to package the source code
101+
due to its ability to remove unused code and ship smaller javascript files
102+
thanks to code splitting. This helps to greatly reduce the size of the package
103+
and to make it easier to use in other projects.
104+
105+
## Development
106+
107+
This project is built using [Nx](https://nx.dev). As a result, many of the usual
108+
commands are available to assist in development.
109+
110+
### Building
111+
112+
Run `nx build biome` to build the library.
113+
114+
### Running unit tests
115+
116+
Run `nx test biome` to execute the unit tests via [Jest](https://jestjs.io).
117+
118+
### Linting
119+
120+
Run `nx lint biome` to run [ESLint](https://eslint.org/) on the package.
121+
122+
<!-- START footer -->
123+
<!-- prettier-ignore-start -->
124+
<!-- markdownlint-disable -->
125+
126+
127+
## Storm Workspaces
128+
129+
Storm workspaces are built using
130+
<a href="https://nx.dev/" target="_blank">Nx</a>, a set of extensible dev tools
131+
for monorepos, which helps you develop like Google, Facebook, and Microsoft.
132+
Building on top of Nx, the Open System provides a set of tools and patterns that
133+
help you scale your monorepo to many teams while keeping the codebase
134+
maintainable.
135+
136+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
137+
<br />
138+
139+
## Roadmap
140+
141+
See the [open issues](https://github.com/storm-software/storm-stack/issues) for
142+
a list of proposed features (and known issues).
143+
144+
- [Top Feature Requests](https://github.com/storm-software/storm-stack/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
145+
(Add your votes using the 👍 reaction)
146+
- [Top Bugs](https://github.com/storm-software/storm-stack/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc)
147+
(Add your votes using the 👍 reaction)
148+
- [Newest Bugs](https://github.com/storm-software/storm-stack/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
149+
150+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
151+
<br />
152+
153+
## Support
154+
155+
Reach out to the maintainer at one of the following places:
156+
157+
- [Contact](https://stormsoftware.com/contact)
158+
- [GitHub discussions](https://github.com/storm-software/storm-stack/discussions)
159+
- <support@stormsoftware.com>
160+
161+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
162+
<br />
163+
164+
## License
165+
166+
This project is licensed under the **Apache License 2.0**. Feel free to edit and
167+
distribute this template as you like.
168+
169+
See [LICENSE](LICENSE) for more information.
170+
171+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
172+
<br />
173+
174+
## Changelog
175+
176+
This project adheres to
177+
[Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every release, along
178+
with the migration instructions, is documented in the [CHANGELOG](CHANGELOG.md)
179+
file
180+
181+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
182+
<br />
183+
184+
## Contributing
185+
186+
First off, thanks for taking the time to contribute! Contributions are what
187+
makes the open-source community such an amazing place to learn, inspire, and
188+
create. Any contributions you make will benefit everybody else and are **greatly
189+
appreciated**.
190+
191+
Please try to create bug reports that are:
192+
193+
- _Reproducible._ Include steps to reproduce the problem.
194+
- _Specific._ Include as much detail as possible: which version, what
195+
environment, etc.
196+
- _Unique._ Do not duplicate existing opened issues.
197+
- _Scoped to a Single Bug._ One bug per report.
198+
199+
Please adhere to this project's [code of conduct](.github/CODE_OF_CONDUCT.md).
200+
201+
You can use
202+
[markdownlint-cli](https://github.com/storm-software/storm-stack/markdownlint-cli)
203+
to check for common markdown style inconsistency.
204+
205+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
206+
<br />
207+
208+
## Contributors
209+
210+
Thanks goes to these wonderful people
211+
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
212+
213+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
214+
215+
<table>
216+
<tbody>
217+
<tr>
218+
<td align="center" valign="top" width="14.28%"><a href="http://www.sullypat.com/"><img src="https://avatars.githubusercontent.com/u/99053093?v=4?s=100" width="100px;" alt="Patrick Sullivan"/><br /><sub><b>Patrick Sullivan</b></sub></a><br /><a href="#design-sullivanpj" title="Design">🎨</a> <a href="https://github.com/storm-software/storm-stack/commits?author=sullivanpj" title="Code">💻</a> <a href="#tool-sullivanpj" title="Tools">🔧</a> <a href="https://github.com/storm-software/storm-stack/commits?author=sullivanpj" title="Documentation">📖</a> <a href="https://github.com/storm-software/storm-stack/commits?author=sullivanpj" title="Tests">⚠️</a></td>
219+
<td align="center" valign="top" width="14.28%"><a href="https://tylerbenning.com/"><img src="https://avatars.githubusercontent.com/u/7265547?v=4?s=100" width="100px;" alt="Tyler Benning"/><br /><sub><b>Tyler Benning</b></sub></a><br /><a href="#design-tbenning" title="Design">🎨</a></td>
220+
<td align="center" valign="top" width="14.28%"><a href="http://stormsoftware.com"><img src="https://avatars.githubusercontent.com/u/149802440?v=4?s=100" width="100px;" alt="Stormie"/><br /><sub><b>Stormie</b></sub></a><br /><a href="#maintenance-stormie-bot" title="Maintenance">🚧</a></td>
221+
</tr>
222+
</tbody>
223+
<tfoot>
224+
<tr>
225+
<td align="center" size="13px" colspan="7">
226+
<img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg" alt="All Contributors">
227+
<a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
228+
</img>
229+
</td>
230+
</tr>
231+
</tfoot>
232+
</table>
233+
234+
<!-- ALL-CONTRIBUTORS-LIST:END -->
235+
236+
This project follows the
237+
[all-contributors](https://github.com/all-contributors/all-contributors)
238+
specification. Contributions of any kind welcome!
239+
240+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
241+
<br />
242+
243+
<hr />
244+
<br />
245+
246+
<div align="center">
247+
<img src="https://public.storm-cdn.com/brand-banner.png" width="100%" alt="Storm Software" />
248+
</div>
249+
<br />
250+
251+
<div align="center">
252+
<a href="https://stormsoftware.com" target="_blank">Website</a> • <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> • <a href="https://linkedin.com/in/patrick-sullivan-865526b0" target="_blank">LinkedIn</a> • <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a> • <a href="https://github.com/storm-software" target="_blank">GitHub</a> • <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
253+
</div>
254+
255+
<div align="center">
256+
<b>Fingerprint:</b> 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D
257+
</div>
258+
<br />
259+
260+
Storm Software is an open source software development organization and creator
261+
of Acidic, StormStack and StormCloud.
262+
263+
Our mission is to make software development more accessible. Our ideal future is
264+
one where anyone can create software without years of prior development
265+
experience serving as a barrier to entry. We hope to achieve this via LLMs,
266+
Generative AI, and intuitive, high-level data modeling/programming languages.
267+
268+
Join us on [Discord](https://discord.gg/MQ6YVzakM5) to chat with the team,
269+
receive release notifications, ask questions, and get involved.
270+
271+
If this sounds interesting, and you would like to help us in creating the next
272+
generation of development tools, please reach out on our
273+
[website](https://stormsoftware.com/contact) or join our
274+
[Slack channel](https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA)!
275+
276+
<br />
277+
278+
<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/icon-fill.png" alt="Storm Software" width="200px"/></a></div>
279+
<br />
280+
<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/visit-us-text.svg" alt="Visit us at stormsoftware.com" height="90px"/></a></div>
281+
282+
<br />
283+
284+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
285+
<br />
286+
<br />
287+
288+
289+
<!-- markdownlint-restore -->
290+
<!-- prettier-ignore-end -->
291+
292+
<!-- END footer -->

packages/tsconfig/package.json

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
{
2+
"name": "@storm-stack/biome",
3+
"version": "0.1.6",
4+
"type": "module",
5+
"description": "A shared Biome configuration containing globals used in Storm Stack projects.",
6+
"repository": {
7+
"type": "github",
8+
"url": "https://github.com/storm-software/storm-stack.git",
9+
"directory": "packages/biome"
10+
},
11+
"homepage": "https://stormsoftware.com",
12+
"bugs": {
13+
"url": "https://stormsoftware.com/support",
14+
"email": "support@stormsoftware.com"
15+
},
16+
"author": {
17+
"name": "Storm Software",
18+
"email": "contact@stormsoftware.com",
19+
"url": "https://stormsoftware.com"
20+
},
21+
"maintainers": [
22+
{
23+
"name": "Storm Software",
24+
"email": "contact@stormsoftware.com",
25+
"url": "https://stormsoftware.com"
26+
}
27+
],
28+
"contributors": [
29+
{
30+
"name": "Storm Software",
31+
"email": "contact@stormsoftware.com",
32+
"url": "https://stormsoftware.com"
33+
}
34+
],
35+
"funding": {
36+
"type": "github",
37+
"url": "https://github.com/sponsors/storm-software"
38+
},
39+
"license": "Apache-2.0",
40+
"private": false,
41+
"exports": {
42+
"./package.json": "./package.json",
43+
"./base.json": "./configs/base.json",
44+
"./plugin.json": "./configs/plugin.json",
45+
"./workspace.json": "./configs/workspace.json",
46+
"./recommended.json": "./configs/recommended.json",
47+
"./strict.json": "./configs/strict.json"
48+
},
49+
"files": [
50+
"configs/**/*"
51+
],
52+
"keywords": [
53+
"storm-stack",
54+
"storm-software",
55+
"typescript",
56+
"tsconfig"
57+
],
58+
"peerDependencies": {
59+
"@storm-software/tsconfig": ">=0.43.15"
60+
},
61+
"peerDependenciesMeta": {
62+
"@storm-software/tsconfig": {
63+
"optional": false
64+
}
65+
},
66+
"devDependencies": {
67+
"@storm-software/tsconfig": "catalog:"
68+
},
69+
"publishConfig": {
70+
"access": "public"
71+
},
72+
"sideEffects": false
73+
}

packages/tsconfig/project.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"name": "tsconfig",
3+
"$schema": "../../node_modules/nx/schemas/project-schema.json",
4+
"projectType": "library",
5+
"sourceRoot": "packages/tsconfig/src",
6+
"targets": {
7+
"build": {
8+
"executor": "nx:run-commands",
9+
"options": {
10+
"commands": [
11+
"pnpm copyfiles LICENSE dist/packages/tsconfig",
12+
"pnpm copyfiles --up=2 ./packages/tsconfig/*.md ./packages/tsconfig/package.json dist/packages/tsconfig",
13+
"pnpm copyfiles --up=3 ./packages/tsconfig/src/*.json dist/packages/tsconfig/configs"
14+
]
15+
}
16+
},
17+
"nx-release-publish": {
18+
"executor": "@storm-software/workspace-tools:npm-publish"
19+
}
20+
},
21+
"tags": ["platform:neutral"]
22+
}

0 commit comments

Comments
 (0)