[major] Sanity V3 Upgrade (#189)

.eslintignore

@@ -0,0 +1,6 @@
+*.js
+.eslintrc.js
+commitlint.config.js
+dist
+lint-staged.config.js
+package.config.ts

.eslintrc

@@ -1,7 +1,42 @@
 {
- "extends": "@ahmdigital/eslint-config/react-config",
- "parser": "@typescript-eslint/parser",
+ "root": true,
+ "env": {
+ "node": true,
+ "browser": true
+ },
+ "extends": [
+ "@ahmdigital/eslint-config/ts-config",
+ "@ahmdigital/eslint-config/react-config",
+ "sanity",
+ "sanity/typescript",
+ "sanity/react",
+ "plugin:import/typescript",
+ "plugin:react-hooks/recommended",
+ "plugin:prettier/recommended",
+ "plugin:react/jsx-runtime"
+ ],
+ "settings": {
+ "import/parsers": {
+ "@typescript-eslint/parser": [".ts", ".tsx"]
+ },
+ "import/resolver": {
+ "node": {
+ "extensions": [".js", ".jsx", ".ts", ".tsx"]
+ }
+ }
+ },
  "rules": {
- "jest/no-deprecated-functions": "off"
+ "jsdoc/require-param-type": "off",
+ "import/extensions": [
+ "error",
+ "ignorePackages",
+ {
+ "js": "never",
+ "jsx": "never",
+ "ts": "never",
+ "tsx": "never",
+ "mjs": "never"
+ }
+ ]
  }
 }

.gitignore

@@ -2,14 +2,11 @@
 logs
 *.log
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
 
 # Runtime data
 pids
 *.pid
 *.seed
-*.pid.lock
 
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
@@ -23,45 +20,41 @@ coverage
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 
-# Bower dependency directory (https://bower.io/)
-bower_components
-
 # node-waf configuration
 .lock-wscript
 
-# Compiled binary addons (https://nodejs.org/api/addons.html)
+# Compiled binary addons (http://nodejs.org/api/addons.html)
 build/Release
 
 # Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
+node_modules
+jspm_packages
 
 # Optional npm cache directory
 .npm
 
-# Optional eslint cache
-.eslintcache
-
 # Optional REPL history
 .node_repl_history
 
-# Output of 'npm pack'
-*.tgz
+# macOS finder cache file
+.DS_Store
 
-# Yarn Integrity file
-.yarn-integrity
+# VS Code settings
+.vscode
 
-# dotenv environment variables file
-.env
+# IntelliJ
+.idea
+*.iml
 
-# next.js build output
-.next
+# Cache
+.cache
+
+# Yalc
+.yalc
+yalc.lock
+
+# npm package zips
+*.tgz
 
-lib
-*.aes
-*.decrypted
-codeship_deploy_key*
-codeship.env
+# Compiled plugin
+dist

CODE_OF_CONDUCT.md

@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Our Responsibilities
 

CONTRIBUTING.md

@@ -3,5 +3,3 @@
 Yes, please!
 
 Repo still needs a way of running locally without a studio, but for now use npm link and develop it against your own studio.
-
-Will add a test runner (jest) at some point if this takes off.

Dockerfile

@@ -1,10 +1,19 @@
 FROM node:16
 
-WORKDIR /root/app
+WORKDIR /var/app
 
-COPY package.json package-lock.json ./
-RUN npm ci --quiet --no-optional && \
- npm cache clean --force
+COPY .eslintignore .
+COPY .eslintrc .
+COPY package-lock.json .
+COPY package.json .
+COPY package.config.ts .
+
+RUN npm install
 
-COPY .eslintrc .babelrc ./
 COPY src ./src
+COPY sanity.json .
+COPY jest.config.js .
+COPY tsconfig.dist.json .
+COPY tsconfig.json .
+COPY tsconfig.settings.json .
+COPY v2-incompatible.js .

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Cameron Chamberlain
+Copyright (c) 2024 Josh Edwards
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,13 +1,26 @@
-# Content Model Graph
+# sanity-plugin-content-model-graph
 
-[![Codeship Status for ahmdigital/content-model-graph](https://app.codeship.com/projects/114f2570-022a-0138-b1be-367aa528a0e6/status?branch=master)](https://app.codeship.com/projects/378236)
-
-Graph your Sanity.io content model straight in your Studio using this tool
+> This is a **Sanity Studio v3** plugin.
 
 ## Installation
 
-1. `sanity install content-model-graph`
-2. There's no step 2.
+```sh
+npm install sanity-plugin-content-model-graph
+```
+
+## Usage
+
+Add it as a plugin in `sanity.config.ts` (or .js):
+
+```ts
+import { defineConfig } from "sanity";
+import { myPlugin } from "sanity-plugin-content-model-graph";
+
+export default defineConfig({
+ //...
+ plugins: [myPlugin({})],
+});
+```
 
 ## Examples (need updating, it looks nicer now)
 
@@ -21,12 +34,14 @@ Graph your Sanity.io content model straight in your Studio using this tool
 ![Screen Shot 2019-11-16 at 11 52 00 pm](https://user-images.githubusercontent.com/4197647/68993455-77886700-08cc-11ea-8a5c-1653d44fee07.png)
 ![Screen Shot 2019-11-16 at 11 52 12 pm](https://user-images.githubusercontent.com/4197647/68993452-77886700-08cc-11ea-8426-02447b894b9f.png)
 
-## Contributing
+## License
 
-Yes, please!
+[MIT](LICENSE) © ahm Digital
 
-Repo still needs a way of running locally without a studio, but for now use `npm link` and develop it against your own studio.
+## Develop & test
 
-Will add a CD integration to npm if this takes off. For now we at least have CI for lint.
+This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
+with default configuration for build & watch scripts.
 
-*NOTE:* This repo is manually released for now.
+See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
+on how to run this plugin with hotreload in the studio.

codeship-steps.yml

@@ -2,6 +2,6 @@
  type: parallel
  service: build-service
  steps:
- - command: npm run lint
- # - command: npm t -- --coverage
- - command: npm run build
+  - command: npm run lint
+   - command: npm t -- --coverage
+  - command: npm run build

jest.config.js

@@ -1,8 +1,4 @@
-// For a detailed explanation regarding each configuration property, visit:
-// https://jestjs.io/docs/en/configuration.html
-
 module.exports = {
- clearMocks: true,
- coverageDirectory: 'coverage',
+ preset: 'ts-jest',
  testEnvironment: 'node',
 };