feat: add a check for the codeblocks in the tutorials

.github/workflows/rebuild-api.yml

@@ -27,6 +27,10 @@ jobs:
           pnpm install
           rm -fR ./docs/api
           pnpm run build:veramo
+          pnpm run format
+      - name: 'check codeblocks'
+        run: |
+          pnpm run check:codeblocks'
       - name: 'Docusaurus build'
         run: |
           pnpm run build

.gitignore

@@ -1,11 +1,12 @@
 # Dependencies
-/node_modules
+**/node_modules
 
 # Production
 /build
 /temp
 /daf
 /veramo
+**/tmp
 
 # Generated files
 .docusaurus
@@ -23,3 +24,11 @@ yarn-debug.log*
 yarn-error.log*
 
 .idea/
+# Generated by `pnpm run baseline:docs`. Ignore for now.
+**/baseline-report.md
+
+## LLMs - not ready to add these to git yet, ignore for now
+AGENTS.md
+CLAUDE.md
+.claude/
+/roadmap/

.prettierignore

@@ -0,0 +1,13 @@
+**/*.png
+**/*.jpg
+**/*.jpeg
+**/*.gif
+**/*.svg
+**/*.ico
+**/*.webp
+**/*.woff
+**/*.woff2
+**/*.ttf
+**/*.eot
+build/
+

docs/basics/identifiers.md

@@ -43,37 +43,37 @@ has available. This is the foundation of how `DIDs` can start to communicate wit
 // https://veramo.io/.well-known/did.json
 
 {
-  "@context": [
-    "https://www.w3.org/ns/did/v1",
-    "https://w3id.org/security/v2",
-    "https://w3id.org/security/suites/secp256k1recovery-2020/v2",
-    "https://w3id.org/security/suites/ed25519-2018/v1"
+  '@context': [
+    'https://www.w3.org/ns/did/v1',
+    'https://w3id.org/security/v2',
+    'https://w3id.org/security/suites/secp256k1recovery-2020/v2',
+    'https://w3id.org/security/suites/ed25519-2018/v1',
   ],
-  "id": "did:web:veramo.io",
-  "verificationMethod": [
+  id: 'did:web:veramo.io',
+  verificationMethod: [
     {
-      "id": "did:web:veramo.io#root-1",
-      "type": "EcdsaSecp256k1VerificationKey2019",
-      "controller": "did:web:veramo.io",
-      "publicKeyHex": "042b0af9b3ae6c7c3a90b01a3879d9518081bc0dcdf038488db9cb109b082a77d97ea3373e3dfde0eccd9adbdce11d0302ea5c098dbb0b310234c86895c8641622"
+      id: 'did:web:veramo.io#root-1',
+      type: 'EcdsaSecp256k1VerificationKey2019',
+      controller: 'did:web:veramo.io',
+      publicKeyHex: '042b0af9b3ae6c7c3a90b01a3879d9518081bc0dcdf038488db9cb109b082a77d97ea3373e3dfde0eccd9adbdce11d0302ea5c098dbb0b310234c86895c8641622',
     },
     {
-      "id": "did:web:veramo.io#root-2",
-      "type": "Ed25519VerificationKey2018",
-      "controller": "did:web:veramo.io",
-      "publicKeyBase58": "ZG6NM2qB1CwADHmJsbGqWVhwmGLrVACBu7xmXJNMWLH"
+      id: 'did:web:veramo.io#root-2',
+      type: 'Ed25519VerificationKey2018',
+      controller: 'did:web:veramo.io',
+      publicKeyBase58: 'ZG6NM2qB1CwADHmJsbGqWVhwmGLrVACBu7xmXJNMWLH',
     },
     {
-      "id": "did:web:veramo.io#root-3",
-      "type": "Ed25519VerificationKey2020",
-      "controller": "did:web:veramo.io",
-      "publicKeyMultibase": "z6Mkf1X8xbHGWYhQGi8TzSZ7gc3hmLYCGNQYsv2tboGPGj7f"
-    }
+      id: 'did:web:veramo.io#root-3',
+      type: 'Ed25519VerificationKey2020',
+      controller: 'did:web:veramo.io',
+      publicKeyMultibase: 'z6Mkf1X8xbHGWYhQGi8TzSZ7gc3hmLYCGNQYsv2tboGPGj7f',
+    },
   ],
-  "authentication": ["did:web:veramo.io#root-1", "did:web:veramo.io#root-2", "did:web:veramo.io#root-3"],
-  "assertionMethod": ["did:web:veramo.io#root-1", "did:web:veramo.io#root-2", "did:web:veramo.io#root-3"],
-  "keyAgreement": ["did:web:veramo.io#root-2", "did:web:veramo.io#root-3"],
-  "service": []
+  authentication: ['did:web:veramo.io#root-1', 'did:web:veramo.io#root-2', 'did:web:veramo.io#root-3'],
+  assertionMethod: ['did:web:veramo.io#root-1', 'did:web:veramo.io#root-2', 'did:web:veramo.io#root-3'],
+  keyAgreement: ['did:web:veramo.io#root-2', 'did:web:veramo.io#root-3'],
+  service: [],
 }
 ```
 

docs/basics/verifiable_data.md

@@ -31,24 +31,20 @@ This is the current v1 format for a W3C compliant Verifiable Credential:
 
 ```json5
 {
-  "@context": [
-    "https://www.w3.org/2018/credentials/v1"
-  ],
-  "type": [
-    "VerifiableCredential"
-  ],
-  "issuer": {
-    "id": "did:web:veramo.io"
+  '@context': ['https://www.w3.org/2018/credentials/v1'],
+  type: ['VerifiableCredential'],
+  issuer: {
+    id: 'did:web:veramo.io',
   },
-  "issuanceDate": "2020-01-01T19:33:24Z",
-  "credentialSubject": {
-    "id": "did:example:user",
-    "community": {
-      "rank": "rockstar"
-    }
+  issuanceDate: '2020-01-01T19:33:24Z',
+  credentialSubject: {
+    id: 'did:example:user',
+    community: {
+      rank: 'rockstar',
+    },
   },
-  "proof": {
+  proof: {
     // ...
-  }
+  },
 }
 ```

docs/dev_tools/agent_explorer_plugin.md

@@ -117,23 +117,23 @@ https://cdn.jsdelivr.net/gh/{USER}/{REPO}/dist/plugin.js
 
 The plugin name
 
-```ts
+```tsx
 name: string
 ```
 
 ### `description`
 
 A short description of the plugin
 
-```ts
+```tsx
 description: string
 ```
 
 ### `icon`
 
 The plugin icon
 
-```ts
+```tsx
 icon?: React.ReactNode;
 ```
 
@@ -143,14 +143,14 @@ These will be displayed in the plugins list
 
 ### `routes`
 
-```ts
+```tsx
 /** An array of routes to be added to the explorer */
 routes?: IRouteComponent[];
 ```
 
 Example:
 
-```ts
+```tsx
 routes: [
   {
     path: '/contacts',
@@ -167,13 +167,13 @@ routes: [
 
 An array of menu items to be added to the explorer
 
-```ts
+```tsx
 menuItems?: ExtendedMenuDataItem[];
 ```
 
 Example:
 
-```ts
+```tsx
 menuItems: [
   {
     name: 'Contacts',
@@ -191,21 +191,21 @@ An array of methods that the plugin requires to be implemented by the agent.
 
 If the agent does not implement the required methods, the plugin will be loaded but the menu item will not be shown.
 
-```ts
+```tsx
 requiredMethods: string[];
 ```
 
 Example:
 
-```ts
+```tsx
 requiredMethods: ['dataStoreORMGetIdentifiers'],
 ```
 
 ### `hasCss`
 
 Does the plugin provide custom css
 
-```ts
+```tsx
 hasCss?: boolean;
 ```
 
@@ -215,15 +215,15 @@ Example: [Brainshare](https://github.com/veramolabs/agent-explorer-plugin-graph-
 
 Veramo agent plugins accesable by all explorer plugins
 
-```ts
+```tsx
 agentPlugins?: IAgentPlugin[];
 ```
 
 ### `messageHandlers`
 
 Veramo agent message handlers
 
-```ts
+```tsx
 messageHandlers?: AbstractMessageHandler[];
 ```
 
@@ -233,13 +233,13 @@ Example: [Chats plugin](https://github.com/veramolabs/agent-explorer/blob/main/p
 
 Menu items for the credential context menu
 
-```ts
+```tsx
 getCredentialContextMenuItems?: (credential: UniqueVerifiableCredential) => MenuProps['items'];
 ```
 
 Example [Chats plugin](https://github.com/veramolabs/agent-explorer/blob/7614ba2a25423aa6304013738af8e67c625394cd/packages/agent-explore/src/plugins/chats/menu.tsx#L8)
 
-```ts
+```tsx
 {
   key: 'sendto',
   label: 'Share with ...',
@@ -254,7 +254,7 @@ Example [Chats plugin](https://github.com/veramolabs/agent-explorer/blob/7614ba2
 
 Returns a react component for a given verifiable credential
 
-```ts
+```tsx
 getCredentialComponent?: (credential: UniqueVerifiableCredential) => React.FC<IVerifiableComponentProps> | undefined;
 ```
 
@@ -266,7 +266,7 @@ Example: [Kudos plugin](https://github.com/veramolabs/agent-explorer-plugin-kudo
 
 Returns a react component that will be displayed in the identifier hover component
 
-```ts
+```tsx
 getIdentifierHoverComponent?: () => React.FC<IIdentifierHoverComponentProps>;
 ```
 
@@ -278,13 +278,13 @@ Example: [Gitcoin Passport plugin](https://github.com/veramolabs/agent-explorer-
 
 Returns an array of react components and labels that will be displayed as tabs in the indentifier profile page
 
-```ts
+```tsx
 getIdentifierTabsComponents?: () => Array<{ label: string, component: React.FC<IIdentifierTabsComponentProps> }>;
 ```
 
 Example: [Credentials plugin](https://github.com/veramolabs/agent-explorer/blob/42c625bdcfe03c725abb2cf3db88bec2e3e90a99/packages/agent-explore/src/plugins/credentials/index.tsx)
 
-```ts
+```tsx
 getIdentifierTabsComponents: () => {
   return [
     {
@@ -305,7 +305,7 @@ getIdentifierTabsComponents: () => {
 
 Returns an array of react components that will be displayed as action buttons in Credential component
 
-```ts
+```tsx
 getCredentialActionComponents?: () => Array<React.FC<ICredentialActionComponentProps>>;
 ```
 
@@ -317,15 +317,15 @@ Example: [Reactions plugin](https://github.com/veramolabs/agent-explorer/blob/ma
 
 `react-markdown` Components for custom markdown rendering
 
-```ts
+```tsx
 getMarkdownComponents?: () => Partial<Components> | undefined;
 ```
 
 ### `getRemarkPlugins`
 
 `remark` plugins for custom markdown manipulations
 
-```ts
+```tsx
 getRemarkPlugins?: () => PluggableList;
 ```
 

docs/dev_tools/veramo_react.md

@@ -80,9 +80,8 @@ In the provider setup above, add the following to bootstrap the local agent. You
 add while your application is running.
 
 ```tsx
-import {agent} from '../veramo';
-
-<VeramoProvider agent={[agent]}>...</VeramoProvider>
+import { agent } from '../veramo'
+;<VeramoProvider agent={[agent]}>...</VeramoProvider>
 ```
 
 ## `useVeramo hook`
@@ -96,17 +95,15 @@ import { useQuery } from 'react-query'
 
 export default () => {
   const { agent } = useVeramo<IResolver>()
-  const { data } = useQuery(
-    ['resolutionResult', { agentId: agent?.context.id }],
-    () => agent?.resolveDid({ didUrl: 'did:web:community.veramo.io' })())
+  const { data } = useQuery(['resolutionResult', { agentId: agent?.context.id }], () =>
+    agent?.resolveDid({ didUrl: 'did:web:community.veramo.io' })(),
+  )
 
   return (
     <div>
-      {
-        data?.didDocument?.verificationMethod.map((key) => (
-          <div>{JSON.stringify(key)}</div>
-        ))
-      }
+      {data?.didDocument?.verificationMethod.map((key) => (
+        <div>{JSON.stringify(key)}</div>
+      ))}
     </div>
   )
 }