Skip to content

docs/issue 188 built in TypeScript support#198

Merged
thescientist13 merged 8 commits intomainfrom
docs/issue-188-built-in-typescript-support
Apr 13, 2025
Merged

docs/issue 188 built in TypeScript support#198
thescientist13 merged 8 commits intomainfrom
docs/issue-188-built-in-typescript-support

Conversation

@thescientist13
Copy link
Copy Markdown
Member

@thescientist13 thescientist13 commented Mar 24, 2025

Related Issue

resolves #188

Summary of Changes

  1. Document useTsc configuration
  2. Moved /docs/plugins/typescript/ -> /docs/resources/typescript/ and revamped for built-in TypeScript support
  3. Update all plugin docs with relevant content re: TypeScript
  4. Updated WTR guides for TypeScript integration

TODO

  1. Need to document new typings (create a new /types/ page in the reference docs?)
    • Configuration
    • Content as Data
    • Compilation
    • Plugin APIs
  2. Showcase JS Docs examples (e.g. config docs, plugin docs, etc)
  3. Remove any references to ServerInterface and ResourceInterface
  4. remove reference to TypeScript plugin from Plugins landing page
  5. Make sure that WCC calls out that it only supports type stripping w/ sucrase
  6. status / feedback on useTsc + greenwood.config.ts - full access to tsc for plugins greenwood#1453
  7. final docs review / proof reading

Question(s)

  1. (nice to have / new issue) - have a JS / TS switcher for code snippets - Add code snippets toggle for JavaScript / TypeScript snippets #205

@thescientist13 thescientist13 added docs Greenwood specific content like docs and guides infra Hosting and CI / CD labels Mar 24, 2025
@thescientist13 thescientist13 self-assigned this Mar 24, 2025
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 24, 2025

Deploy Preview for super-tapioca-5987ce ready!

Name Link
🔨 Latest commit d7fbef4
🔍 Latest deploy log https://app.netlify.com/sites/super-tapioca-5987ce/deploys/67fb1c3f90e21200088adeaf
😎 Deploy Preview https://deploy-preview-198--super-tapioca-5987ce.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@thescientist13 thescientist13 changed the title docs/issue 188 built in typescript support docs/issue 188 built in TypeScript support Mar 26, 2025
@thescientist13 thescientist13 marked this pull request as ready for review April 2, 2025 00:56
@thescientist13 thescientist13 added release/v0.32.0 question Further information is requested labels Apr 2, 2025
Comment thread src/pages/docs/resources/typescript.md Outdated

1. You will need to use Node **>= 22.6.0** and set the `--experimental-strip-types` flag
1. Install TypeScript into your project, e.g. `npm i typescript --save-dev`
1. Create a _tsconfig.json_ file at the root of your project with these minimum configuration settings

This comment was marked as resolved.

"module": "preserve",
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"verbatimModuleSyntax": false,

This comment was marked as resolved.

Comment thread src/pages/docs/reference/plugins-api.md Outdated
<app-ctc-block variant="snippet">

```js
/** @type {import("@greenwood/cll").AdapterPlugin} */

This comment was marked as resolved.

@thescientist13 thescientist13 force-pushed the docs/issue-188-built-in-typescript-support branch from 960b273 to d7fbef4 Compare April 13, 2025 02:06
@thescientist13 thescientist13 merged commit 34cf9e7 into main Apr 13, 2025
5 checks passed
@thescientist13 thescientist13 deleted the docs/issue-188-built-in-typescript-support branch April 13, 2025 02:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Greenwood specific content like docs and guides infra Hosting and CI / CD question Further information is requested release/v0.32.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Greenwood types and first party TypeScript support

1 participant