Merge pull request #6 from ortus-boxlang/development

Name change update
ortus-boxlang · Sep 19, 2024 · ca71fcd · ca71fcd
2 parents 677e845 + ec29563
commit ca71fcd
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 28 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -11,8 +11,7 @@ IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for deta
 All PRs must have an accompanied Jira issue. Please make sure you created it and linked it here.
 
 BoxLang Jira: https://ortussolutions.atlassian.net/browse/BL/issues
-Module Issues: https://github.com/ortus-boxlang/bx-compat/issues
-
+Module Issues: https://github.com/ortus-boxlang/bx-compat-cfml/issues
 
 ## Type of change
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -30,7 +30,7 @@ This project is open-source, and as such, the maintainers give their free time t
 BoxLang tracks its issues in Jira and each module track it's own issues in its repo.
 
 - BoxLang JIra : https://ortussolutions.atlassian.net/browse/BL/issues
-- Module Issues: https://github.com/ortus-boxlang/bx-compat/issues
+- Module Issues: https://github.com/ortus-boxlang/bx-compat-cfml/issues
 
 If you file a bug report, your issue should contain a title, a clear description of the issue, a way to replicate the issue, and any support files that we might need to replicate your issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix for it.  All issues that do not contain a way to replicate will not be addressed.
 

diff --git a/box.json b/box.json
@@ -1,16 +1,16 @@
 {
-	"name": "BoxLang Compat Module",
+	"name": "BoxLang Compat Module For CFML",
 	"version": "@build.version@+@build.number@",
-	"location": "https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-compat/@build.version@/bx-compat-@build.version@.zip",
+	"location": "https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-compat-cfml/@build.version@/bx-compat-cfml-@build.version@.zip",
 	"author": "Ortus Solutions",
-	"homepage": "https://github.com/ortus-boxlang/bx-compat",
-	"documentation": "https://github.com/ortus-boxlang/bx-compat",
+	"homepage": "https://github.com/ortus-boxlang/bx-compat-cfml",
+	"documentation": "https://github.com/ortus-boxlang/bx-compat-cfml",
 	"repository": {
 		"type": "git",
-		"URL": "https://github.com/ortus-boxlang/bx-compat"
+		"URL": "https://github.com/ortus-boxlang/bx-compat-cfml"
 	},
-	"bugs": "https://github.com/ortus-boxlang/bx-compat/issues",
-	"slug": "bx-compat",
+	"bugs": "https://github.com/ortus-boxlang/bx-compat-cfml/issues",
+	"slug": "bx-compat-cfml",
 	"shortDescription": "Compatibility module for BoxLang so it behaves like a CFML engine",
 	"type": "boxlang-modules",
 	"private": false,
@@ -41,7 +41,7 @@
 		"onRelease": "publish"
 	},
 	"boxlang": {
-		"moduleName": "compat",
+		"moduleName": "compat-cfml",
 		"minimumVersion": "1.0.0"
 	}
 }
diff --git a/build.gradle b/build.gradle
@@ -155,7 +155,7 @@ task createModuleStructure(type: Copy) {
 		// Token Replacements Go Here
 		filter{ line -> line.replaceAll( '@build.version@', project.version ) }
 		if( project.branch == "development" ){
-			filter{ line -> line.replaceAll( '\\+@build.number@', '-SNAPSHOT' ) }
+			filter{ line -> line.replaceAll( '\\+@build.number@', '' ) }
 		} else {
 			filter{ line -> line.replaceAll( '@build.number@', project.buildID ) }
 		}
@@ -167,7 +167,7 @@ task createModuleStructure(type: Copy) {
 		// Token Replacements Go Here
 		filter{ line -> line.replaceAll( '@build.version@', project.version ) }
 		if( project.branch == "development" ){
-			filter{ line -> line.replaceAll( '\\+@build.number@', '-SNAPSHOT' ) }
+			filter{ line -> line.replaceAll( '\\+@build.number@', '' ) }
 		} else {
 			filter{ line -> line.replaceAll( '@build.number@', project.buildID ) }
 		}

diff --git a/changelog.md b/changelog.md
@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Name change to `bx-compat-cfml` to better describe the module
+
 ## [1.4.1] - 2024-09-19
 
 ## [1.4.0] - 2024-09-16
@@ -62,16 +66,16 @@ transpiler = {
 
 - First iteration of this module
 
-[Unreleased]: https://github.com/ortus-boxlang/bx-compat/compare/v1.4.1...HEAD
+[Unreleased]: https://github.com/ortus-boxlang/bx-compat-cfml/compare/v1.4.1...HEAD
 
-[1.4.1]: https://github.com/ortus-boxlang/bx-compat/compare/v1.4.0...v1.4.1
+[1.4.1]: https://github.com/ortus-boxlang/bx-compat-cfml/compare/v1.4.0...v1.4.1
 
-[1.4.0]: https://github.com/ortus-boxlang/bx-compat/compare/v1.3.0...v1.4.0
+[1.4.0]: https://github.com/ortus-boxlang/bx-compat-cfml/compare/v1.3.0...v1.4.0
 
-[1.3.0]: https://github.com/ortus-boxlang/bx-compat/compare/v1.2.0...v1.3.0
+[1.3.0]: https://github.com/ortus-boxlang/bx-compat-cfml/compare/v1.2.0...v1.3.0
 
-[1.2.0]: https://github.com/ortus-boxlang/bx-compat/compare/v1.1.0...v1.2.0
+[1.2.0]: https://github.com/ortus-boxlang/bx-compat-cfml/compare/v1.1.0...v1.2.0
 
-[1.1.0]: https://github.com/ortus-boxlang/bx-compat/compare/v1.1.0...v1.1.0
+[1.1.0]: https://github.com/ortus-boxlang/bx-compat-cfml/compare/v1.1.0...v1.1.0
 
-[1.0.0]: https://github.com/ortus-boxlang/bx-compat/compare/06e6a42cf95887e081e639073f36b481eb334097...v1.0.0
+[1.0.0]: https://github.com/ortus-boxlang/bx-compat-cfml/compare/06e6a42cf95887e081e639073f36b481eb334097...v1.0.0
diff --git a/gradle.properties b/gradle.properties
@@ -1,5 +1,5 @@
-#Mon Sep 16 17:48:00 UTC 2024
+#Thu Sep 19 13:43:38 UTC 2024
 boxlangVersion=1.0.0-snapshot
 jdkVersion=21
-version=1.4.1
+version=1.6.0
 group=ortus.boxlang
diff --git a/readme.md b/readme.md
@@ -1,4 +1,4 @@
-# ⚡︎ BoxLang Module: BoxLang Compat Module
+# ⚡︎ BoxLang Module: BoxLang Compat Module For CFML
 
 ```
 |:------------------------------------------------------:|
@@ -16,11 +16,11 @@
 
 <p>&nbsp;</p>
 
-## Welcome to the BoxLang Compat Module
+## Welcome to the BoxLang Compat Module For CFML
 
 This module will allow your ColdFusion (CFML) applications under Adobe or Lucee to run under BoxLang.  This module will provide the necessary compatibility layer to run your applications under BoxLang.
 
-If there are any issues, please report them to the [BoxLang JIRA](https://ortussolutions.atlassian.net/browse/BL/issues) or the [Module Issues](https://github.com/ortus-boxlang/bx-compat/issues) repository.
+If there are any issues, please report them to the [BoxLang JIRA](https://ortussolutions.atlassian.net/browse/BL/issues) or the [Module Issues](https://github.com/ortus-boxlang/bx-compat-cfml/issues) repository.
 
 ## Settings
 
@@ -36,7 +36,7 @@ The valid engines are `adobe` or `lucee`.  By default the engine is `lucee`.  Al
 
 ```json
 "modules" : {
-    "compat" : {
+    "compat-cfml" : {
         "disabled" : false,
         "settings" : {
             "engine" : "adobe"

diff --git a/settings.gradle b/settings.gradle
@@ -1,2 +1,2 @@
 // The name of the module
-rootProject.name = 'bx-compat'
+rootProject.name = 'bx-compat-cfml'
diff --git a/src/main/bx/ModuleConfig.bx b/src/main/bx/ModuleConfig.bx
@@ -44,7 +44,7 @@
 	 * The BoxLang mapping for your module.  All BoxLang modules are registered with an internal
 	 * mapping prefix of : bxModules.{this.mapping}, /bxmodules/{this.mapping}. Ex: bxModules.test, /bxmodules/test
 	 */
-	this.mapping = "bxCompat";
+	this.mapping = "compat-cfml";
 
 	/**
 	 * Who built the module