v9 (TypeScript conversion) (#1087)

Author: carloskelly13

.babelrc

@@ -1,7 +1,8 @@
 {
   "presets": [
+    "@babel/preset-typescript",
     ["@babel/preset-env", { "modules": false }],
-    "@babel/preset-react"
+    ["@babel/preset-react", { "runtime": "automatic" }]
   ],
   "plugins": [
     "@babel/plugin-proposal-object-rest-spread",

.eslintrc

@@ -5,7 +5,7 @@
     "plugin:react/recommended",
     "plugin:prettier/recommended",
     "plugin:react-hooks/recommended",
-    "prettier/react"
+    "prettier"
   ],
   "plugins": [
     "prettier",
@@ -44,6 +44,16 @@
       {
         "allowTemplateLiterals": true
       }
-    ]
-  }
-}
+    ],
+    "react/jsx-uses-react": "off",
+    "react/react-in-jsx-scope": "off"
+  },
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {
+        "react/prop-types": "off"
+      }
+    }
+  ]
+}

.github/PULL_REQUEST_TEMPLATE.md

@@ -28,7 +28,6 @@ Please describe the tests that you ran to verify your changes. Provide instructi
 - [ ] I have performed a self-review of my own code
 - [ ] I have commented my code, particularly in hard-to-understand areas
 - [ ] I have made corresponding changes to the documentation
-- [ ] I have updated type definitions in `index.d.ts` for any breaking API changes
 - [ ] My code follows the style guidelines of this project (I have run `yarn format`)
 - [ ] I have added tests that prove my fix is effective or that my feature works
 - [ ] New and existing unit tests pass locally with my changes (I have run `yarn test`)

.github/workflows/ci.yml

@@ -13,6 +13,8 @@ on:
   pull_request:
     branches:
       - main
+      # TODO(v9): Remove when targeting branch at `main` for real release.
+      - v9
     paths:
       - '**'
       - '!docs/**'
@@ -23,7 +25,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 15.x]
+        node-version: [12.x, 14.x, 16.x]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2

.prettierignore

@@ -1,8 +1,10 @@
 yarn.lock
 package.json
+tsconfig.json
 node_modules
 es
 lib
 dist
+docs
 .nova
-.vscode
+.vscode

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 9.0.0-beta.7
+
+- Ensured types for styled-system based components are included with Spectacle core
+
+## 9.0.0-beta.6
+
+- Fixed path for emitting type declarations
+
+## 9.0.0-beta.5
+
+- Removed dependency on Node assert
+
+## 9.0.0-beta.3
+
+- Added TypeScript development example
+
+## 9.0.0-beta.2
+
+- webpack 5 upgrade (@carlos-kelly)
+
+## 9.0.0-beta.1
+
+- Finished initial pass of TypeScript conversion (@scottrippey)
+
 ## 8.5.0
 
 - Add styled-system position and layout functions to CodePane, Progress, Markdown components [#1079](https://github.com/FormidableLabs/spectacle/pull/1079)

CONTRIBUTING.md

@@ -168,8 +168,6 @@ ahead and submit a PR, make sure that you have done the following:
 - Run all checks using `yarn check-ci`.
 - Run `yarn build-one-page` and check + commit changes to `examples/one-page.html`
 - Check that both the core library and _all_ examples build: `yarn build && yarn build-examples`.
-- Update the [type definitions](./index.d.ts) for anything that modifies the Spectacle API,
-  like breaking changes or new features.
 - Everything else included in our [pull request checklist](.github/PULL_REQUEST_TEMPLATE.md).
 
 ### Releasing a new version to NPM

README.md

@@ -24,3 +24,7 @@ Spectacle's documentation lives on our [docs site](https://www.formidable.com/op
 Notice something inaccurate or confusing? Feel free to [open an issue](https://github.com/FormidableLabs/spectacle/issues)
 or [make a pull request](https://github.com/FormidableLabs/spectacle/pulls) to help improve the documentation for everyone!
 The source for our docs site lives in this repo in the [`docs`](https://github.com/FormidableLabs/spectacle/blob/main/docs/README.md) folder.
+
+### Maintenance Status
+
+**Active:** Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.

docs/content/basic-concepts.md

@@ -17,7 +17,7 @@ $ npm install --save spectacle
 
 ## Getting Started with Development
 
-The `src` directory contains all the source for the Spectacle library. All components designed to be part of the Spectacle API must be exported in `src/index.js`.
+The `src` directory contains all the source for the Spectacle library. All components designed to be part of the Spectacle API must be exported in `src/index.tsx`.
 
 #### JavaScript-based Decks
 

docs/content/faq.md

@@ -15,4 +15,4 @@ For more info about the query parameters Spectacle supports, please check out ou
 
 ## Can I write my presentation in TypeScript?
 
-Yes - Spectacle types are shipped with the package, so you can safely use Spectacle in any `.ts` or `.js` presentation without a separate type definition import. Check out [the exported types](https://github.com/FormidableLabs/spectacle/blob/main/index.d.ts) for a complete list.
+Yes - Spectacle types are shipped with the package, so you can safely use Spectacle in any `.ts` or `.js` presentation without a separate type definition import.