fix: add missing bare workflow notes to schema

.prettierrc.js

@@ -4,4 +4,5 @@ module.exports = {
   singleQuote: true,
   jsxBracketSameLine: true,
   trailingComma: 'es5',
+  endOfLine: 'auto',
 };

src/manifest/__tests__/index.test.ts

@@ -14,7 +14,7 @@ describe('activateGlobalSchema', () => {
     const storagePath = vscode.Uri.file('path/to/file');
 
     jest.spyOn(xdlVersions, 'newestReleasedSdkVersionAsync').mockResolvedValue(versionData);
-    const schemaSpy = jest.spyOn(schema, 'getSchema').mockResolvedValue(schemaData);
+    const schemaSpy = jest.spyOn(schema, 'create').mockResolvedValue(schemaData);
     const storageSpy = jest.spyOn(storage, 'storeSchema').mockResolvedValue(storagePath);
     const configSpy = jest.spyOn(config, 'registerGlobalSchema').mockResolvedValue();
 

src/manifest/__tests__/schema.test.ts

@@ -7,12 +7,12 @@ import * as schema from '../schema';
 // note: this is the same value as `traverse`, but typed as mock
 const mockedTraverse = (traverse as unknown) as jest.Mock<[object, TraverseCallback]>;
 
-describe('getSchema', () => {
+describe('create', () => {
   it('fetches schema by expo sdk version', async () => {
     const xdlSchema = tools.getFixtureFile('schema-xdl-39.0.0.json');
     const spy = jest.spyOn(xdl, 'getSchemaAsync').mockResolvedValue(xdlSchema);
 
-    expect(await schema.getSchema('39.0.0')).toBeDefined();
+    expect(await schema.create('39.0.0')).toBeDefined();
     expect(spy).toBeCalledWith('39.0.0');
   });
 });
@@ -35,3 +35,48 @@ describe('createFromXdl', () => {
     expect(createdSchema).toStrictEqual(expect.objectContaining(simpleSchema));
   });
 });
+
+describe('mutateSchemaBareWorkflowDescription', () => {
+  const description = 'Info about a property';
+  const bareWorkflow = 'Check this other property out instead';
+
+  it('skips without `schema.meta.bareWorkflow`', () => {
+    const property = { description };
+    schema.mutateSchemaBareWorkflowDescription(property);
+    expect(property.description).toBe(description);
+  });
+
+  it('appends `schema.meta.bareWorkflow` to missing `schema.description`', () => {
+    const property = { meta: { bareWorkflow } };
+    schema.mutateSchemaBareWorkflowDescription(property);
+    expect(property).toHaveProperty('description', `**Bare workflow** - ${bareWorkflow}`);
+  });
+
+  it('appends `schema.meta.bareWorkflow` to existing `schema.description`', () => {
+    const property = { description, meta: { bareWorkflow } };
+    schema.mutateSchemaBareWorkflowDescription(property);
+    expect(property.description).toBe(`${description}\n\n**Bare workflow** - ${bareWorkflow}`);
+  });
+});
+
+describe('mutateSchemaMarkdownDescription', () => {
+  const description = 'Info about a property';
+
+  it('skips without `schema.description`', () => {
+    const property = {};
+    schema.mutateSchemaMarkdownDescription(property);
+    expect(property).not.toHaveProperty('markdownDescription');
+  });
+
+  it('copies `schema.description` to `schema.markdownDescription`', () => {
+    const property = { description };
+    schema.mutateSchemaMarkdownDescription(property);
+    expect(property).toHaveProperty('markdownDescription', description);
+  });
+
+  it('skips copy `schema.description` to `schema.markdownDescription` if it exists already', () => {
+    const property = { description, markdownDescription: 'Something else' };
+    schema.mutateSchemaMarkdownDescription(property);
+    expect(property).toHaveProperty('markdownDescription', 'Something else');
+  });
+});

src/manifest/index.ts

@@ -11,7 +11,7 @@ import * as storage from './storage';
  */
 export async function activateGlobalSchema(context: vscode.ExtensionContext) {
   const latestSdk = await xdlVersions.newestReleasedSdkVersionAsync();
-  const schemaFile = await schema.getSchema(latestSdk.version);
+  const schemaFile = await schema.create(latestSdk.version);
   const storagePath = await storage.storeSchema(context, schemaFile);
   await config.registerGlobalSchema(storagePath);
 }

src/manifest/schema.ts

@@ -17,21 +17,21 @@ export type ManifestSchema = {
 };
 
 /**
- * Fetch the XDL schema for a specific Expo SDK version.
+ * Create a vscode compatible JSON schema by fetching the versioned XDL schema.
  */
-export async function getSchema(sdkVersion: string) {
+export async function create(sdkVersion: string) {
   const xdlSchema = await xdl.getSchemaAsync(sdkVersion);
   return createFromXdl(sdkVersion, xdlSchema);
 }
 
 /**
  * Create a vscode compatible JSON schema object from XDL schema.
- * It also adds a `meta` property to know when this schema was generated.
  * This will try to make some adjustments to the downloaded schema:
  *   1. wrap the properties into an `expo` property for managed validation
- *   2. copy `description` properties into `markdownDescription` to render content as markdown
+ *   2. append `schema.meta.bareWorkflow` notes to the `schema.description`
+ *   2. copy `schema.description` properties into `schema.markdownDescription` to render as markdown
  *
- * @remark When something fails in #2, it falls back to the original schema and only apply #1.
+ * @remark When something fails in 2..3, it falls back to the original schema and only apply 1.
  * @see https://github.com/microsoft/vscode/blob/1dff50d211472de4667db626ef2d6d32265eb0e6/src/vs/workbench/services/configuration/common/configurationExtensionPoint.ts#L64
  */
 export function createFromXdl(sdkVersion: string, xdlSchema: JsonSchema): ManifestSchema {
@@ -40,9 +40,8 @@ export function createFromXdl(sdkVersion: string, xdlSchema: JsonSchema): Manife
 
   try {
     jsonSchemaTraverse(enhancedSchema, (nestedSchema: JsonSchema) => {
-      if (nestedSchema.description && !nestedSchema.markdownDescription) {
-        nestedSchema.markdownDescription = nestedSchema.description;
-      }
+      mutateSchemaBareWorkflowDescription(nestedSchema);
+      mutateSchemaMarkdownDescription(nestedSchema);
     });
   } catch (error) {
     // todo: add telemetry, fallback to original schema
@@ -60,3 +59,25 @@ export function createFromXdl(sdkVersion: string, xdlSchema: JsonSchema): Manife
     },
   };
 }
+
+/**
+ * Appends the `meta.bareWorkflow` to the `descrption` with a `**Bare Workflow**` prefix.
+ * If there is no `meta.bareWorkflow` value, it's skipped.
+ */
+export function mutateSchemaBareWorkflowDescription(schema: JsonSchema) {
+  if (schema.meta?.bareWorkflow) {
+    const description = schema.description || '';
+    const bareNotes = schema.meta.bareWorkflow;
+    schema.description = `${description}\n\n**Bare workflow** - ${bareNotes}`.trim();
+  }
+}
+
+/**
+ * Copies the `description` property to `markdownDescription` for vscode markdown rendering.
+ * If there is no `description` value, it skips the `markdownDescription`.
+ */
+export function mutateSchemaMarkdownDescription(schema: JsonSchema) {
+  if (schema.description && !schema.markdownDescription) {
+    schema.markdownDescription = schema.description;
+  }
+}