fix: format readmes and examples

README.md

@@ -76,13 +76,13 @@ cd /path/to/my-studio
 npx yalc add sanity-plugin-testing-it-out && npx yalc link sanity-plugin-testing-it-out && npm install
 ```
 
-Now, configure the plugin in sanity.config.ts (or .js) in Sanity Studio:
+Now, configure the plugin in `sanity.config.ts` (or .js) in Sanity Studio:
 
 ```ts
   import {defineConfig} from 'sanity'
   import {myPlugin} from 'sanity-plugin-testing-it-out'
 
-  export const defineConfig({
+  export default defineConfig({
       //...
       plugins: [
           myPlugin({})

src/configs/default-source.ts

@@ -15,9 +15,7 @@ export function defaultSourceJs(pkg: PackageJson) {
    *
    * export default defineConfig({
    *   // ...
-   *   plugins: [
-   *     myPlugin({}),
-   *   ],
+   *   plugins: [myPlugin({})],
    * })
    * \`\`\`
    */
@@ -42,17 +40,15 @@ export function defaultSourceTs(pkg: PackageJson) {
   }
 
   /**
-   * Usage in sanity.config.ts (or .js)
+   * Usage in \`sanity.config.ts\` (or .js)
    *
    * \`\`\`ts
    * import {defineConfig} from 'sanity'
    * import {myPlugin} from '${pkg.name}'
    *
    * export default defineConfig({
    *   // ...
-   *   plugins: [
-   *     myPlugin(),
-   *   ],
+   *   plugins: [myPlugin()],
    * })
    * \`\`\`
    */

src/util/readme.ts

@@ -7,30 +7,32 @@ import {User} from './user'
 export function generateReadme(data: PackageData) {
   const {user, pluginName, license, description} = data
 
-  return outdent`
+  return (
+    outdent`
     # ${pluginName}
 
     ${v3BannerNotice()}
 
     ${installationSnippet(pluginName ?? 'unknown')}
 
     ## Usage
-    Add it as a plugin in sanity.config.ts (or .js):
 
+    Add it as a plugin in \`sanity.config.ts\` (or .js):
+
+    \`\`\`ts
+    import {defineConfig} from 'sanity'
+    import {myPlugin} from '${pluginName}'
+
+    export default defineConfig({
+      //...
+      plugins: [myPlugin({})],
+    })
     \`\`\`
-     import {defineConfig} from 'sanity'
-     import {myPlugin} from '${pluginName}'
-
-     export const defineConfig({
-         //...
-         plugins: [
-             myPlugin({})
-         ]
-     })
-    \`\`\`
+
     ${getLicenseText(license?.id, user?.name ? (user as User) : undefined)}
     ${developTestSnippet()}
-  `
+  ` + '\n'
+  )
 }
 
 export function v3BannerNotice() {
@@ -41,8 +43,8 @@ export function installationSnippet(packageName: string) {
   return outdent`
     ## Installation
 
-    \`\`\`
-    npm install --save ${packageName}@studio-v3
+    \`\`\`sh
+    npm install ${packageName}
     \`\`\`
     `
 }

test/fixtures/inject/valid/README.md

@@ -15,12 +15,9 @@ Install the plugin in your [Sanity Studio](https://sanity.io/studio) configurati
 import {defineConfig} from 'sanity'
 import {myPlugin} from 'sanity-plugin-test-plugin'
 
-export const defineConfig({
+export default defineConfig({
   // ...
-
-  plugins: [
-    myPlugin(),
-  ],
+  plugins: [myPlugin({})],
 })
 ```
 

test/fixtures/inject/valid/src/index.ts

@@ -5,17 +5,15 @@ interface MyPluginConfig {
 }
 
 /**
- * ## Usage in sanity.config.ts (or .js)
+ * Usage in `sanity.config.ts` (or .js)
  *
- * ```
+ * ```ts
  * import {defineConfig} from 'sanity'
  * import {myPlugin} from 'sanity-plugin-test-plugin'
  *
- * export const defineConfig({
- *     /...
- *     plugins: [
- *         myPlugin({})
- *     ]
+ * export default defineConfig({
+ *   // ...
+ *   plugins: [myPlugin({})],
  * })
  * ```
  */

test/fixtures/verify-package/every-failure-possible/README.md

@@ -2,30 +2,22 @@
 
 ## Installation
 
-```
-npm install --save my-plugin
-```
-
-or
-
-```
-yarn add my-plugin
+```sh
+npm install my-plugin
 ```
 
 ## Usage
 
-Add it as a plugin in sanity.config.ts (or .js):
+Add it as a plugin in `sanity.config.ts` (or .js):
 
-```
- import {defineConfig} from 'sanity'
- import {myPlugin} from 'my-plugin'
-
- export const defineConfig({
-     /...
-     plugins: [
-         myPlugin({})
-     ]
- })
+```ts
+import {defineConfig} from 'sanity'
+import {myPlugin} from 'my-plugin'
+
+export default defineConfig({
+  // ...
+  plugins: [myPlugin({})],
+})
 ```
 
 ## License

test/fixtures/verify-package/invalid-eslint/README.md

@@ -2,30 +2,22 @@
 
 ## Installation
 
-```
-npm install --save sanity-plugin-test-plugin
-```
-
-or
-
-```
-yarn add sanity-plugin-test-plugin
+```sh
+npm install sanity-plugin-test-plugin
 ```
 
 ## Usage
 
-Add it as a plugin in sanity.config.ts (or .js):
+Add it as a plugin in `sanity.config.ts` (or .js):
 
-```
- import {defineConfig} from 'sanity'
- import {myPlugin} from 'sanity-plugin-test-plugin'
-
- export const defineConfig({
-     /...
-     plugins: [
-         myPlugin({})
-     ]
- })
+```ts
+import {defineConfig} from 'sanity'
+import {myPlugin} from 'sanity-plugin-test-plugin'
+
+export default defineConfig({
+  // ...
+  plugins: [myPlugin({})],
+})
 ```
 
 ## License

test/fixtures/verify-package/invalid-eslint/src/index.ts

@@ -5,17 +5,15 @@ interface MyPluginConfig {
 }
 
 /**
- * ## Usage in sanity.config.ts (or .js)
+ * Usage in `sanity.config.ts` (or .js)
  *
- * ```
+ * ```ts
  * import {defineConfig} from 'sanity'
  * import {myPlugin} from 'sanity-plugin-test-plugin'
  *
- * export const defineConfig({
- *     /...
- *     plugins: [
- *         myPlugin({})
- *     ]
+ * export default defineConfig({
+ *   // ...
+ *   plugins: [myPlugin({})],
  * })
  * ```
  */

test/fixtures/verify-package/valid/README.md

@@ -2,30 +2,22 @@
 
 ## Installation
 
-```
-npm install --save sanity-plugin-test-plugin
-```
-
-or
-
-```
-yarn add sanity-plugin-test-plugin
+```sh
+npm install sanity-plugin-test-plugin
 ```
 
 ## Usage
 
-Add it as a plugin in sanity.config.ts (or .js):
+Add it as a plugin in `sanity.config.ts` (or .js):
 
-```
- import {defineConfig} from 'sanity'
- import {myPlugin} from 'sanity-plugin-test-plugin'
-
- export const defineConfig({
-     /...
-     plugins: [
-         myPlugin({})
-     ]
- })
+```ts
+import {defineConfig} from 'sanity'
+import {myPlugin} from 'sanity-plugin-test-plugin'
+
+export default defineConfig({
+  // ...
+  plugins: [myPlugin({})],
+})
 ```
 
 ## License

test/fixtures/verify-package/valid/src/index.ts

@@ -5,17 +5,15 @@ interface MyPluginConfig {
 }
 
 /**
- * ## Usage in sanity.config.ts (or .js)
+ * Usage in `sanity.config.ts` (or .js)
  *
- * ```
+ * ```ts
  * import {defineConfig} from 'sanity'
  * import {myPlugin} from 'sanity-plugin-test-plugin'
  *
- * export const defineConfig({
- *     /...
- *     plugins: [
- *         myPlugin({})
- *     ]
+ * export default defineConfig({
+ *   // ...
+ *   plugins: [myPlugin({})],
  * })
  * ```
  */