styleguide.config.js

/* Released under the BSD 2-Clause License
 *
 * Copyright © 2018-present, terrestris GmbH & Co. KG and GeoStyler contributors
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

const path = require('path');
const webpackConfig = require('./webpack.dev.config');
const rdt = require('react-docgen-typescript');
const packageJson = require('./package.json');

module.exports = {
  title: 'GeoStyler',
  version: packageJson.version,
  styleguideDir: './build/styleguide',
  webpackConfig: {
    ...webpackConfig,
    mode: process.env.NODE_ENV
  },
  template: {
    favicon: './geostyler-favicon.svg'
  },
  minimize: process.env.NODE_ENV === 'production',
  assetsDir: './docs',
  propsParser: process.env.NODE_ENV === 'production' ?
    rdt
      .withCustomConfig('./tsconfig.json', {propFilter: (prop) => {
        if (prop.parent) {
          return !prop.parent.fileName.includes('node_modules');
        }
        return true;
      }})
      .parse :
    undefined,
  components: 'src/Component/**/*.tsx',
  getExampleFilename(componentPath) {
    return componentPath.replace(/\.tsx?$/, '.example.md')
  },
  ignore: [
    '**/*.spec.{js,jsx,ts,tsx}',
    '**/*.d.ts',
    'src/index.ts'
  ],
  moduleAliases: {
    'geostyler': path.resolve(__dirname, 'src')
  },
  usageMode: 'expand',
  pagePerSection: true,
  sections: [{
    name: 'Introduction',
    content: './docs/introduction.md',
    sectionDepth: 0
  }, {
    name: 'Components',
    sections: [{
      name: 'BulkEditor',
      components: 'src/Component/BulkEditor/**/*.tsx'
    }, {
      name: 'CodeEditor',
      components: 'src/Component/CodeEditor/**/*.tsx'
    }, {
      name: 'DataInput',
      components: 'src/Component/DataInput/**/*.tsx'
    }, {
      name: 'FieldSet',
      components: 'src/Component/FieldSet/**/*.tsx'
    }, {
      name: 'Filter',
      components: 'src/Component/Filter/**/*.tsx'
    }, {
      name: 'FilterOverview',
      components: 'src/Component/FilterOverview/**/*.tsx'
    }, {
      name: 'LocaleWrapper',
      components: 'src/Component/LocaleWrapper/**/*.tsx'
    }, {
      name: 'NameField',
      components: 'src/Component/NameField/**/*.tsx'
    }, {
      name: 'Rule',
      components: 'src/Component/Rule/**/*.tsx'
    }, {
      name: 'RuleCard',
      components: 'src/Component/RuleCard/**/*.tsx'
    }, {
      name: 'Rules',
      components: 'src/Component/Rules/**/*.tsx'
    }, {
      name: 'RuleGenerator',
      components: 'src/Component/RuleGenerator/**/*.tsx'
    }, {
      name: 'RuleTable',
      components: 'src/Component/RuleTable/**/*.tsx'
    }, {
      name: 'ScaleDenominator',
      components: 'src/Component/ScaleDenominator/**/*.tsx'
    }, {
      name: 'Style',
      components: 'src/Component/Style/**/*.tsx'
    }, {
      name: 'StyleOverview',
      components: 'src/Component/StyleOverview/**/*.tsx'
    }, {
      name: 'CardStyle',
      components: 'src/Component/CardStyle/**/*.tsx'
    }, {
      name: 'RemovableItem',
      components: 'src/Component/RemovableItem/**/*.tsx'
    }, {
      name: 'RuleOverview',
      components: 'src/Component/RuleOverview/**/*.tsx'
    }, {
      name: 'SymbolizerCard',
      components: 'src/Component/SymbolizerCard/**/*.tsx'
    }, {
      name: 'Symbolizers',
      components: 'src/Component/Symbolizers/**/*.tsx'
    }, {
      name: 'Selectable',
      components: 'src/Component/Selectable/*.tsx'
    }, {
      name: 'Symbolizer',
      components: 'src/Component/Symbolizer/**/*.tsx'
    }, {
      name: 'UploadButton',
      components: 'src/Component/UploadButton/**/*.tsx'
    }, {
      name: 'Breadcrumb',
      components: 'src/Component/Breadcrumb/**/*.tsx'
    }, {
      name: 'Renderer',
      components: 'src/Component/Renderer/**/*.tsx'
    }, {
      name: 'PreviewMap',
      components: 'src/Component/PreviewMap/**/*.tsx'
    }, {
      name: 'FieldContainer',
      components: 'src/Component/FieldContainer/**/*.tsx'
    }, {
      name: 'StyleFieldContainer',
      components: 'src/Component/StyleFieldContainer/**/*.tsx'
    }, {
      name: 'RuleFieldContainer',
      components: 'src/Component/RuleFieldContainer/**/*.tsx'
    }, {
      name: 'DataInput',
      components: 'src/Component/DataInput/**/*.tsx'
    }],
    sectionDepth: 2
  }, {
    name: 'Context',
    sections: [{
      name: 'CompositionContext',
      content: 'src/context/CompositionContext/CompositionContext.example.md'
    }, {
      name: 'UnsupportedPropertiesContext',
      content: 'src/context/UnsupportedPropertiesContext/UnsupportedPropertiesContext.example.md'
    }],
    sectionDepth: 1
  }],
  require: [
    path.join(__dirname, 'node_modules/antd/dist/antd.css')
  ]
};