[auto] Reflect the changes of main repository.

README.md

@@ -1,114 +1,58 @@
-<!--- version = v2023-06-01-bc03 --->
+<!--- version = v2023-11-13 --->
 
 # 🐕 qq-shell-color
 
 **qq-shell-color** is a Kotlin library that can color your console output.
 
 ## How to use
-- Just copy and paste Single-File version [QShColor.kt](src-single/QShColor.kt) into your project.
+- Just copy and paste Single-File version [QColor.kt](src-single/QColor.kt) into your project.
 - Or you can use Jar version. See [Maven Dependency Section](#jar-version-maven-dependency).
 - Feel free to fork or copy to your own codebase 😍
 
-## Example
 
-### output
-<p align="center">
-
-</p>
-<p align="center">
- <img src="img/result.png" width="587" alt="result.png">
-</p>
-
-### code example
-
-Full Source : [QShColorExample.kt](src-example/QShColorExample.kt)
-
-```kotlin
-fun colorful() {
- println("c".yellow + "o".blue + "l".red + "o".purple + "u".green + "r".cyan + "f".yellow + "u".blue + "l".red)
-}
-
-fun regex() {
- val txt = """val color = "you can use regex to color targeted text"""".qColorTarget(
- ptn = """val(?!\S)""".toRegex(),
- fg = QShColor.Purple
- ).qColorTarget(
- ptn = """".*?"""".toRegex(),
- fg = QShColor.Green
- )
-
- println(txt)
-}
-
-fun background() {
- println("background".qColor(fg = QShColor.Red, bg = QShColor.Blue))
-}
-
-fun decorate() {
- println("underlined".underline)
- println("italic".italic)
- println("bold".bold)
-}
-
-fun nest() {
- println("ne${"stab".blue.underline}le".yellow)
-}
-
-fun multiline() {
- val txt = """
- multiline
- multiline
- """.trimIndent().blue.underline
-
- println(txt)
-}
-```
-
-Please see [QShColorTest.kt](src-test-split/nyab/util/QShColorTest.kt) for more code examples.
-Single-File version [src-test-single/QShColorTest.kt](src-test-single/QShColorTest.kt) is a self-contained source code that includes a runnable main function.
-You can easily copy and paste it into your codebase. 
 
 ## Public API
 
-- [`String.qColor()`](src-split/nyab/util/QShColor.kt#L38-L47) *extension function*
-- [`String.qDeco()`](src-split/nyab/util/QShColor.kt#L49-L58) *extension function*
-- [`String.qColorAndDecoDebug()`](src-split/nyab/util/QShColor.kt#L174-L188) *extension function*
-- [`String.qColorTarget()`](src-split/nyab/util/QShColor.kt#L190-L193) *extension function*
-- [`String.qDecoTarget()`](src-split/nyab/util/QShColor.kt#L195-L198) *extension function*
-- [`String.qColorRandom()`](src-split/nyab/util/QShColor.kt#L200-L201) *extension function*
-- [`String.bold`](src-split/nyab/util/QShColor.kt#L203-L205) *extension property*
-- [`String.italic`](src-split/nyab/util/QShColor.kt#L207-L209) *extension property*
-- [`String.underline`](src-split/nyab/util/QShColor.kt#L211-L213) *extension property*
-- [`String.black`](src-split/nyab/util/QShColor.kt#L215-L217) *extension property*
-- [`String.red`](src-split/nyab/util/QShColor.kt#L219-L221) *extension property*
-- [`String.green`](src-split/nyab/util/QShColor.kt#L223-L225) *extension property*
-- [`String.yellow`](src-split/nyab/util/QShColor.kt#L227-L229) *extension property*
-- [`String.blue`](src-split/nyab/util/QShColor.kt#L231-L233) *extension property*
-- [`String.purple`](src-split/nyab/util/QShColor.kt#L235-L237) *extension property*
-- [`String.cyan`](src-split/nyab/util/QShColor.kt#L239-L241) *extension property*
-- [`String.light_gray`](src-split/nyab/util/QShColor.kt#L243-L245) *extension property*
-- [`String.dark_gray`](src-split/nyab/util/QShColor.kt#L247-L249) *extension property*
-- [`String.light_red`](src-split/nyab/util/QShColor.kt#L251-L253) *extension property*
-- [`String.light_green`](src-split/nyab/util/QShColor.kt#L255-L257) *extension property*
-- [`String.light_yellow`](src-split/nyab/util/QShColor.kt#L259-L261) *extension property*
-- [`String.light_blue`](src-split/nyab/util/QShColor.kt#L263-L265) *extension property*
-- [`String.light_magenta`](src-split/nyab/util/QShColor.kt#L267-L269) *extension property*
-- [`String.light_cyan`](src-split/nyab/util/QShColor.kt#L271-L273) *extension property*
-- [`String.white`](src-split/nyab/util/QShColor.kt#L275-L277) *extension property*
-- [`String.noStyle`](src-split/nyab/util/QShColor.kt#L279-L283) *extension property*
-- [`QShDeco`](src-split/nyab/util/QShColor.kt#L88-L109) *enum class*
-- [`QShColor`](src-split/nyab/util/QShColor.kt#L111-L172) *enum class*
+- [`String.qColor()`](src-split/nyab/util/QColor.kt#L23-L32) *extension function*
+- [`String.qDeco()`](src-split/nyab/util/QColor.kt#L33-L42) *extension function*
+- [`String.qColorAndDecoDebug()`](src-split/nyab/util/QColor.kt#L168-L180) *extension function*
+- [`String.qColorTarget()`](src-split/nyab/util/QColor.kt#L181-L184) *extension function*
+- [`String.qDecoTarget()`](src-split/nyab/util/QColor.kt#L185-L188) *extension function*
+- [`String.qColorRandom()`](src-split/nyab/util/QColor.kt#L189-L190) *extension function*
+- [`String.bold`](src-split/nyab/util/QColor.kt#L191-L193) *extension property*
+- [`String.italic`](src-split/nyab/util/QColor.kt#L194-L196) *extension property*
+- [`String.underline`](src-split/nyab/util/QColor.kt#L197-L199) *extension property*
+- [`String.black`](src-split/nyab/util/QColor.kt#L200-L202) *extension property*
+- [`String.red`](src-split/nyab/util/QColor.kt#L203-L205) *extension property*
+- [`String.green`](src-split/nyab/util/QColor.kt#L206-L208) *extension property*
+- [`String.yellow`](src-split/nyab/util/QColor.kt#L209-L211) *extension property*
+- [`String.blue`](src-split/nyab/util/QColor.kt#L212-L214) *extension property*
+- [`String.purple`](src-split/nyab/util/QColor.kt#L215-L217) *extension property*
+- [`String.cyan`](src-split/nyab/util/QColor.kt#L218-L220) *extension property*
+- [`String.light_gray`](src-split/nyab/util/QColor.kt#L221-L223) *extension property*
+- [`String.dark_gray`](src-split/nyab/util/QColor.kt#L224-L226) *extension property*
+- [`String.light_red`](src-split/nyab/util/QColor.kt#L227-L229) *extension property*
+- [`String.light_green`](src-split/nyab/util/QColor.kt#L230-L232) *extension property*
+- [`String.light_yellow`](src-split/nyab/util/QColor.kt#L233-L235) *extension property*
+- [`String.light_blue`](src-split/nyab/util/QColor.kt#L236-L238) *extension property*
+- [`String.light_magenta`](src-split/nyab/util/QColor.kt#L239-L241) *extension property*
+- [`String.light_cyan`](src-split/nyab/util/QColor.kt#L242-L244) *extension property*
+- [`String.white`](src-split/nyab/util/QColor.kt#L245-L247) *extension property*
+- [`String.noStyle`](src-split/nyab/util/QColor.kt#L248-L252) *extension property*
+- [`QDeco`](src-split/nyab/util/QColor.kt#L66-L85) *enum class*
+- [`QColor`](src-split/nyab/util/QColor.kt#L86-L167) *enum class*
 
 ## Single-File version Dependency
 
-If you copy & paste [QShColor.kt](src-single/QShColor.kt),
-fefer to [build.gradle.kts](build.gradle.kts) to directly check project settings.
+If you copy & paste [QColor.kt](src-single/QColor.kt),
+refer to [build.gradle.kts](build.gradle.kts) to directly check project settings.
 
 
 
 ```kotlin
 dependencies {
  implementation("org.jetbrains.kotlin:kotlin-stdlib:1.8.20")
+ implementation("org.jetbrains.kotlin:kotlin-compiler-embeddable:1.8.20")
  implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.20")
 }
 ```

VERSION

@@ -1,3 +1,3 @@
-v2023-06-01-bc03
-1ddf26a7dc44060e1bf8265f481a1ab2016158ff05cb200903268ebffb3bdb4434620d7203c0fb8c4955f093d5fa35deccc46cb3805d3d1d1be2d1da819d6f98
-build/libs/qq-shell-color-v2023-06-01-bc03.jar;build/libs/qq-shell-color-v2023-06-01-bc03-sources.jar
+v2023-11-13
+1d6795fd94e402ab4af9af8df131e0e6e4e27fa3760ff685b8c2a2f60a9b99fea3d5d7ead8ea8e99cb784744c8ebd5f90c39abe643919c79e907621b4fffba26
+build/libs/qq-shell-color-v2023-11-13.jar;build/libs/qq-shell-color-v2023-11-13-sources.jar

build.gradle.kts

@@ -1,13 +1,3 @@
-/*
- * Copyright 2023. nyabkun
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 println("This Gradle script starts with -Dfile.encoding=" + System.getProperty("file.encoding"))
@@ -29,7 +19,7 @@ plugins {
 
 group = "com.github.nyabkun"
 
-version = "v2023-06-01-bc03"
+version = "v2023-11-13"
 
 repositories {
  mavenCentral()
@@ -56,24 +46,7 @@ sourceSets.test {
  resources.srcDirs("rsc-test")
 }
 
-sourceSets.register("example") {
- java.srcDirs("src-example")
- val jarFile = "$buildDir/libs/$qMavenArtifactId-$version.jar"
- compileClasspath += files(jarFile)
- runtimeClasspath += files(jarFile)
-
- resources.srcDirs("rsc")
-}
-
-tasks.getByName("compileExampleKotlin").dependsOn("jar")
-
-val exampleImplementation: Configuration by configurations.getting {
- extendsFrom(configurations.implementation.get())
-}
 
-val exampleRuntimeOnly: Configuration by configurations.getting {
- extendsFrom(configurations.runtimeOnly.get())
-}
 
 sourceSets.register("single") {
  java.srcDirs("src-single")
@@ -103,6 +76,7 @@ val testSingleRuntimeOnly: Configuration by configurations.getting {
 
 dependencies {
  implementation("org.jetbrains.kotlin:kotlin-stdlib:1.8.20")
+ implementation("org.jetbrains.kotlin:kotlin-compiler-embeddable:1.8.20")
  implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.20")
 }
 
@@ -158,24 +132,20 @@ tasks {
  }
 
  register<JavaExec>("qRunTestSplit") {
- mainClass.set("nyab.util.QShColorTestKt")
+ mainClass.set("nyab.util.QColorTestKt")
  classpath = sourceSets.get("test").runtimeClasspath
  }
 
  register<JavaExec>("qRunTestSingle") {
- mainClass.set("QShColorTestKt")
+ mainClass.set("QColorTestKt")
  classpath = sourceSets.get("testSingle").runtimeClasspath
  }
 
- register<JavaExec>("qRunExample") {
- mainClass.set("shcolor.QShColorExampleKt")
- classpath = sourceSets.get("example").runtimeClasspath
- }
+
 
  getByName<Test>("test") {
  dependsOn("qRunTestSingle")
  dependsOn("qRunTestSplit")
- dependsOn("qRunExample")
  }
 }