@sigmacomputing/plugin 0.7.57 → 1.0.0-rc.1

package/.gitignore

@@ -0,0 +1,30 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+node_modules/
+
+# testing
+coverage/
+
+# production
+dist/
+
+# misc
+.DS_Store
+.env.local
+.envrc
+eslint_output.json
+tsc_output
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# vim
+*.swp
+
+# IDE files
+.idea
+
+# typescript
+tsconfig*.tsbuildinfo

package/.lintstagedrc

@@ -0,0 +1,3 @@
+{
+  "*.{js,ts,tsx}": "yarn prettier --write"
+}

package/.nvmrc

@@ -0,0 +1 @@
+v16.13.1

package/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "arrowParens": "avoid",
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+## v1.0.0 (September 2nd, 2022)
+
+`@sigmacomputing/plugin` has moved to https://github.com/sigmacomputing/plugin and
+is now open source. Feel free to create an issue or contribute by opening a pull
+request. Read out `CONTRIBUTING.md` guide to get started.
+
+#### Breaking Changes
+
+- `@sigmacomputing/plugin-types` has been merged with `@sigmacomputing/plugin`
+  and will no longer received updates in the future. Please use only
+  `@sigmacomputing/plugin` going forward.
+
+- All `react` exports (`SigmaClientProvider` and all hooks) have been moved to
+  a separate explicit export. This will allow better bundle splitting by not
+  including `react` specific code for plugins that do not use `react`.
+
+  ```ts
+  // before
+  import { SigmaClientProvider, usePlugin } from '@sigmacomputing/plugin';
+
+  // after
+  import { SigmaClientProvider, usePlugin } from '@sigmacomputing/plugin/react';
+  ```
+
+  All types can be imported from either `@sigmacomputing/plugin` or `@sigmacomputing/plugin/react`

package/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+## Initial setup
+
+Start by forking the `@sigmacomputing/plugin` repo and cloning it locally.
+
+```shs
+git clone https://github.com/your-username/sigmacomputing-plugin.git
+```
+
+Navigate to the `sigmacomputing-plugin` directory and install the required
+dependencies with the following commands:
+
+```sh
+# Ensure you have node version 16 installed (suggestion: v16.13.1).
+nvm install
+yarn install
+```
+
+## Start Developing
+
+You can run any of the scripts located in the `package.json` using:
+
+```sh
+yarn <script-name>
+```
+
+For example, you can run the build process with
+
+```sh
+yarn build
+# Or in watch mode
+yarn build:watch
+```
+
+### Add tests
+
+Unit tests ensure that `@sigmacomputing/plugin` doesn't break accidentally. If
+your code can regress in non-obvious ways, include unit tests with your PR. Use
+the following naming convention:
+
+```
++-- parentFolder
+|   +-- __tests__
+|       +-- [filename].test.ts
+|   +-- [filename].ts
+```
+
+Our unit test suite uses [jest](https://jestjs.io/)
+
+## Submit a pull request
+
+Before submitting your contribution, run the test suite one last time with:
+
+```sh
+yarn test
+```
+
+Doing this prevents last-minute bugs and is also a great way to get your
+contribution merged faster once you submit your pull request. Failing to do so
+will lead to one of the maintainers mark the pull request with the Work in
+Progress label until all tests pass.