Smartconfig Maven Plugin

a maven plugin for config text file

License	The Apache Software License, Version 2.0
Categories	Maven Build Tools config Application Layer Libs Configuration
GroupId	com.github.zdsiyan
ArtifactId	smartconfig-maven-plugin
Last Version	1.0
Release Date	Dec 9, 2016
Type	maven-plugin
Description	Smartconfig Maven Plugin a maven plugin for config text file
Project URL	https://github.com/zdsiyan/smartconfig
Project Organization	BruceZhang
Source Code Management	https://github.com/zdsiyan/smartconfig

Download smartconfig-maven-plugin

Filename	Size
smartconfig-maven-plugin-1.0.pom
smartconfig-maven-plugin-1.0.jar	441 KB
smartconfig-maven-plugin-1.0-sources.jar	312 KB

How to add to project

Apache Maven

<plugin>
    <groupId>com.github.zdsiyan</groupId>
    <artifactId>smartconfig-maven-plugin</artifactId>
    <version>1.0</version>
</plugin>

Dependencies

compile (8)

Group / Artifact	Type	Version
org.apache.maven : maven-plugin-api	jar	3.3.9
org.apache.maven : maven-core	jar	3.3.9
org.codehaus.plexus : plexus-utils	jar	3.0.24
org.apache.commons : commons-lang3	jar	3.5
org.jdom : jdom2	jar	2.0.6
com.ximpleware : vtd-xml	jar	2.13
commons-io : commons-io	jar	2.5
commons-configuration : commons-configuration	jar	1.10

provided (1)

Group / Artifact	Type	Version
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.5

Project Modules

There are no modules declared in this project.

smartconfig

a super extension with fastconfig

Features:

• supply most of the text file
• supply multi mode for replace the text(property, xpath, jsonpath, regex)
• supply reference maven parameters
• supply rename file and directory
• supply sample javascript judge

Install:

• sample:

    <plugin>
        <groupId>com.github.zdsiyan</groupId>
        <artifactId>smartconfig-maven-plugin</artifactId>
        <version>1.0</version>
        <executions>
            <execution>
                <id>config-resources</id>
                <goals>
                <goal>configure</goal>
                </goals>
            </execution>
        </executions>
        <configuration>
            <config>smart-config.xml</config>
            [<encoding>UTF-8</encoding>]
            [<outputDirectory>${project.build.directory}/${project.build.finalName}</outputDirectory>]
        </configuration>
    </plugin>

• include rename:

	<plugin>
		<groupId>com.github.zdsiyan</groupId>
		<artifactId>smartconfig-maven-plugin</artifactId>
		<version>1.0</version>
		<executions>
			<execution>
				<id>config-resources</id>
				<goals>
					<goal>configure</goal>
				</goals>
				<configuration>
					<config>smart-config.xml</config>
					[<encoding>UTF-8</encoding>]
					[<outputDirectory>${project.build.directory}/${project.build.finalName}</outputDirectory>]
				</configuration>
			</execution>
			
			<execution>
				<id>replace-resources</id>
				<goals>
					<goal>configure</goal>
				</goals>
				<configuration>
					<config>smart-rename.xml</config>
					[<encoding>UTF-8</encoding>]
	      			[<outputDirectory>${project.build.directory}/${project.build.finalName}</outputDirectory>]
				</configuration>
			</execution>
		</executions>
	</plugin>

• config configuration file
• encoding target file encoding
• outputDirectory output directory

Configuration file

• sample

<smart-config>
    <config-file path="test.properties">
      	<pointhandle expression="project_name">${project_name}</pointhandle>
    	<pointhandle expression="static.file">**</pointhandle>
    	<pointhandle expression="abc.ddd">**</pointhandle>
    	<pointhandle expression="web.dir"/>
    </config-file>
    <config-file path="test.xml">
      <pointhandle expression="/server/port">80</pointhandle>
      <pointhandle expression="//host[@id='1']">192.168.1.1</pointhandle>
      <pointhandle expression="//host[@id='2']">192.168.1.2</pointhandle>
      <pointhandle expression="/server/mode/@value">run</pointhandle>
    </config-file>
    <config-file path="xxx\spring-context.xml">
	  	<pointhandle expression="//*[@id='dataSource']" mode="delete"/>
	  	<pointhandle expression="//import[contains(@resource,'cache')]" mode="delete"/>
	  	<pointhandle expression="/beans/*[1]" mode="insert">${node1}</pointhandle>
	  	<pointhandle expression="/beans/*[last()]" mode="insert">${node2}</pointhandle>
	</config-file>
    <config-file path="test.json">
      <pointhandle expression="$.store.book[?(@.author='Evelyn Waugh')].author">Kevin Zou</pointhandle>
      <pointhandle expression="$.store.bicycle.color">${hello.param}</pointhandle>
      <pointhandle expression="$.store.bicycle.price">29.99</pointhandle>
    </config-file>
    <config-file path="test.html" mode="regex">
      <pointhandle expression="&lt;p&gt;(.*?)&lt;/p&gt;">&lt;a&gt;$1__Testing__\\__\$2&lt;/a&gt;</pointhandle>
    </config-file>
</smart-config>

• rename and script

<smart-config>
  <config-file path="xxx\xxx.properties" replace="${project_name}.properties"/>
  <config-file path="xxx" replace="${project_name}-rename-direct" disable="('xxx' == project_name)?true:false"/>
</smart-config>

• config-file instructions

  • path: source file path
  • mode: value(property, xpath, jsonpath, regex). The file type determines the default values.
  • replace: target file/directory name
  • disable: can execute a sample javascript code to judge whether the config-file is effective

• pointhandle instructions

  • expression: replace expression
  • mode: value(insert, delete) design for xml, and also supply json properties.

Versions

Version
1.0 Dec 9, 2016