archetype-metadata.xml

<!--
| Copyright 2018 Adobe Incorporated
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
-->
<archetype-descriptor name="basic">
    <fileSets>
        <fileSet filtered="true" encoding="UTF-8">
            <directory></directory>
            <includes>
                <include>README.md</include>
            </includes>
        </fileSet>
        <fileSet filtered="true" encoding="UTF-8">
            <directory></directory>
            <includes>
                <include>.gitignore</include>
                <include>.editorconfig</include>
            </includes>
        </fileSet>
        <fileSet filtered="true" packaged="false">
            <directory>core</directory>
            <includes>
                <include>pom.xml</include>
            </includes>
        </fileSet>
        <fileSet filtered="true" packaged="true">
            <directory>core/src/main/java</directory>
        </fileSet>
        <fileSet filtered="true" packaged="true">
            <directory>core/src/test/java</directory>
        </fileSet>

        <fileSet filtered="true" packaged="false">
            <directory>all</directory>
        </fileSet>
        <fileSet filtered="true" packaged="false">
            <directory>ui.apps</directory>
        </fileSet>
        <fileSet filtered="true" packaged="false">
            <directory>ui.content</directory>
        </fileSet>

        <!-- React app -->
        <fileSet filtered="true" packaged="false">
            <directory>react-app</directory>
            <excludes>
                <!-- Do not filter binary files -->
                <exclude>**/*.gif</exclude>
                <exclude>**/*.ico</exclude>
                <exclude>**/*.jpeg</exclude>
                <exclude>**/*.jpg</exclude>
                <exclude>**/*.png</exclude>
                <exclude>**/*.svg</exclude>
            </excludes>
        </fileSet>
        <fileSet filtered="false" packaged="false">
            <directory>react-app</directory>
            <includes>
                <!-- Do not filter binary files -->
                <include>**/*.gif</include>
                <include>**/*.ico</include>
                <include>**/*.jpeg</include>
                <include>**/*.jpg</include>
                <include>**/*.png</include>
                <include>**/*.svg</include>
            </includes>
        </fileSet>

        <!-- Angular app -->
        <fileSet filtered="true" packaged="false">
            <directory>angular-app</directory>
            <excludes>
                <!-- Do not filter binary files -->
                <exclude>**/*.gif</exclude>
                <exclude>**/*.ico</exclude>
                <exclude>**/*.jpeg</exclude>
                <exclude>**/*.jpg</exclude>
                <exclude>**/*.png</exclude>
                <exclude>**/*.svg</exclude>
            </excludes>
        </fileSet>
        <fileSet filtered="false" packaged="false">
            <directory>angular-app</directory>
            <includes>
                <!-- Do not filter binary files -->
                <include>**/*.gif</include>
                <include>**/*.ico</include>
                <include>**/*.jpeg</include>
                <include>**/*.jpg</include>
                <include>**/*.png</include>
                <include>**/*.svg</include>
            </includes>
        </fileSet>
    </fileSets>

    <requiredProperties>
        <!--
            PROPERTIES WITHOUT DEFAULTS
            (Users will be prompted to provide these)
        -->

        <!-- `projectTitle`: Descriptive project name (e.g. `My App`) -->
        <requiredProperty key="projectTitle" />

        <!-- `projectName`: Technical project name, used for building AEM paths
            (like `/content/${projectName}/en`, e.g. `myapp`) -->
        <requiredProperty key="projectName">
            <validationRegex>^[a-zA-Z0-9\_]+$</validationRegex>
        </requiredProperty>

        <!-- `groupId`: ID which uniquely identifies your group and project,
            should start with a reversed domain name you control (e.g.
            `com.mycompany`) -->
        <requiredProperty key="groupId">
            <validationRegex>^[a-zA-Z0-9\.\-_]+$</validationRegex>
        </requiredProperty>

        <!-- `optionFrontend`: Frontend framework to use in the generated
            project (either `angular` or `react`) -->
        <requiredProperty key="optionFrontend">
            <validationRegex>^(angular|react)$</validationRegex>
        </requiredProperty>

        <!--
            PROPERTIES WITH DEFAULTS
            (Users will not be prompted for these unless they answer the
            confirmation prompt with "N", see
            https://issues.apache.org/jira/browse/ARCHETYPE-308)
        -->

        <!-- `artifactId`: Maven artifact "root" artifactId, is prefixed to the
            individual modules (e.g. `com.mycompany.myapp`) -->
        <requiredProperty key="artifactId">
            <validationRegex>^[a-zA-Z0-9\.\-_]+$</validationRegex>
            <defaultValue>${projectName}</defaultValue>
        </requiredProperty>

        <!-- `package`: Java class package name (e.g. `com.mycompany.myapp`) -->
        <requiredProperty key="package">
            <validationRegex>^[a-z0-9\.]+$</validationRegex>
            <defaultValue>${groupId}.${projectName}</defaultValue>
        </requiredProperty>

        <!-- `version`: Maven artifact version (e.g. `1.0.0-SNAPSHOT`) -->
        <requiredProperty key="version">
            <validationRegex>^\d+(\.\d+){0,2}(\-SNAPSHOT)?$</validationRegex>
            <defaultValue>1.0.0-SNAPSHOT</defaultValue>
        </requiredProperty>

        <!-- `componentGroup`: Name of the component group in the AEM Editor
            (e.g. `My App`) -->
        <requiredProperty key="componentGroup">
            <defaultValue>${projectTitle}</defaultValue>
        </requiredProperty>
    </requiredProperties>
</archetype-descriptor>