vulcan-vscode-snippets's Introduction

VulcanJS Snippets

The official Snippets extension for VulcanJS.

Supported languages

JavaScript (.js)
JavaScript React (.jsx)

Support for TypeScript and TypeScript React will be added when the core framework supports it.

Supported snippets

`addRoute`

Docs | Add a route with a registered component

addRoute({ name: '', path: '/path', componentName: '' });

`addRouteComponent`

Docs | Add a route with a direct component

addRoute({ name: '', path: '/path', component:  });

`createCollection`

Docs | Create a collection with custom queries & mutations

const MyDocuments = createCollection({
  collectionName: 'MyDocuments',
  typeName: 'MyDocument',
  schema: mySchema,
  resolvers: myResolvers,
  mutations: myMutations,
});

`createDefaultCollection`

Docs | Create a collection with default queries & mutations

const MyDocuments = createCollection({
  collectionName: 'MyDocuments',
  typeName: 'MyDocument',
  schema: mySchema,
  resolvers: getDefaultResolvers('MyDocument'),
  mutations: getDefaultMutations('MyDocument'),
});

`registerComponent`

Docs | Register a new component

registerComponent({ name: 'MyComponent', component: MyComponent, hocs: [] });

`registerFragment`

Docs | Register a new fragment

registerFragment(`
  fragment myFragment on MyType {

  }
`)

`newField`

Docs | Insert a field inside a schema

myFieldName: {
  type: String,
  label: 'MyFieldName',
  optional: true,
  canRead: [],
  canCreate: [],
  canUpdate: [],
},

`addField`

Docs | Extend an exisiting collection with a new field

.addField({
  fieldName: 'myFieldName',
  fieldSchema: {
    type: String,
    optional: true,
    canRead: [],
    canCreate: [],
    canUpdate: [],
  },
});