@vuedoc/parser/src/schema/options.ts

Generate a JSON documentation for a Vue file

import { DEFAULT_IGNORED_VISIBILITIES, Features, DEFAULT_ENCODING } from '../lib/Enum.js';

export default {
  type: 'object',
  properties: {
    filename: {
      type: 'string',
      description: 'The filename to parse. Required unless `filecontent` is passed',
    },
    filecontent: {
      type: 'string',
      description: 'The file content to parse. Required unless `filename` is passed',
    },
    encoding: {
      type: 'string',
      description: 'The file encoding',
      default: DEFAULT_ENCODING,
    },
    features: {
      type: 'array',
      description: 'The component features to parse and extract',
      items: {
        type: 'string',
        enum: Features,
      },
      default: Features,
    },
    loaders: {
      type: 'array',
      description: 'Use this option to define custom loaders for specific languages',
    },
    composition: {
      type: 'object',
      description: 'Additional composition tokens for advanced components',
      properties: {
        data: {
          type: 'array',
          items: {
            type: 'string',
          },
        },
        methods: {
          type: 'array',
          items: {
            type: 'string',
          },
        },
        computed: {
          type: 'array',
          items: {
            type: 'string',
          },
        },
        props: {
          type: 'array',
          items: {
            type: 'string',
          },
        },
      },
    },
    ignoredVisibilities: {
      type: 'array',
      description: 'List of ignored visibilities',
      items: {
        type: 'string',
      },
      default: DEFAULT_IGNORED_VISIBILITIES,
    },
  },
};