feat: create a lexer (#2)

* feat: basic parser state instantiated

* refactor: string and file types in separate states

* refactor: updated to k2 and migrated state related classes to state package

* refactor: re-wrote the state classes to work with tokens

* feat: first token, EOF with dummy lexical parsing

* feat: added lexer's initial configuration

* fix: make Position class internal

* chore: update docs

* feat: defining data sources for the lexer

* feat: defining data sources for the lexer

* feat: Lexer is now able to classify identifier tokens

* docs: updated the config for docs generation

* refactor: migrate to package name without core

* refactor: renamed skipCharacters to tokenSeparators

* docs: rearranged the docs for Lexer to make each property private

* feat: lexer re-written to keep a list of tokens

* feat: testing token positions

* feat: added basic functionality to ignore comments

* fix: combines all token separators to split potential tokens properly

* docs: updated to include lexer constructor parameters

* feat: lexer can skip over multiline comments

* feat!: removed tokenSeparator and converted the strings to regexes

* feat: returns EOF when multiline comments do not end

* feat: LexicalException for custom exception messages

* refactor: changed var names and added comments

* fix: able to return 3 tokens from the same line

* refactor: remove redundant setter

* feat: introduce ignorePattern and improve documentation

* docs: explain operators and separators restriction

* refactor: changed how to detect and work with comments

* refactor: changed the way how tokens are extracted

* chore: update docs

* chore: changed parkour name

* chore: updated docs

* feat: added code for hardKeywords

* feat: added support for operators and separators

* test: added separator test cases

* refactor: common function for long tokens

* chore: bumping version to 0.1.0

0.1.0 will be the release version number of the lexer when merged to main.

* chore: update docs [skip ci]

* feat: revamped Token sealed class and introduced integer literals

* fix: floating literals are detected properly

* wip: setup lexer to detect string literals [skip ci]

* tests: floating points with underscores

* feat: basic character capturing

* style: add docs to private functions for reference

* feat: escape sequences in the lexer

* docs: updated for literals

Author: cybercoder-naj

.idea/.name

@@ -3,6 +3,7 @@ import com.vanniktech.maven.publish.KotlinJvm
 import com.vanniktech.maven.publish.SonatypeHost
 import org.jetbrains.dokka.gradle.DokkaTask
 import java.net.URI
+import java.util.*
 
 plugins {
   kotlin("jvm") version "2.0.0"
@@ -33,13 +34,14 @@ kotlin {
 }
 
 tasks.withType<DokkaTask>().configureEach {
-  moduleName.set(project.name)
+  val projectName = project.name.replaceFirstChar { if (it.isLowerCase()) it.titlecase(Locale.getDefault()) else it.toString() }
+  moduleName.set(projectName)
   moduleVersion.set(project.version.toString())
   outputDirectory.set(docsDir)
   dokkaSourceSets.configureEach {
     sourceLink {
       localDirectory.set(projectDir.resolve("src"))
-      remoteUrl.set(URI.create("https://github.com/cybercoder-naj/Parkour/blob/main/src").toURL())
+      remoteUrl.set(URI.create("https://github.com/cybercoder-naj/parkour/tree/main/src").toURL())
       remoteLineSuffix.set("#L")
     }
   }
@@ -68,14 +70,14 @@ mavenPublishing {
   coordinates(project.group.toString(), project.name, project.version.toString())
 
   pom {
-    name.set("Parkour")
+    name.set("parkour")
     description.set("Parser Combinator library for Kotlin")
     inceptionYear.set("2024")
-    url.set("https://github.com/cybercoder-naj/Parkour/")
+    url.set("https://github.com/cybercoder-naj/parkour/")
     licenses {
       license {
         name.set("MIT License")
-        url.set("https://github.com/cybercoder-naj/Parkour/blob/main/LICENSE")
+        url.set("https://github.com/cybercoder-naj/parkour/tree/main/LICENSE")
         distribution.set("repo")
       }
     }
@@ -87,9 +89,9 @@ mavenPublishing {
       }
     }
     scm {
-      url.set("https://github.com/cybercoder-naj/Parkour/")
-      connection.set("scm:git:git://github.com/cybercoder-naj/Parkour.git")
-      developerConnection.set("scm:git:ssh://[email protected]/cybercoder-naj/Parkour.git")
+      url.set("https://github.com/cybercoder-naj/parkour/")
+      connection.set("scm:git:git://github.com/cybercoder-naj/parkour.git")
+      developerConnection.set("scm:git:ssh://[email protected]/cybercoder-naj/parkour.git")
     }
   }
 }

.idea/codeStyles/codeStyleConfig.xml

@@ -2,7 +2,7 @@
 <html class="no-js">
 <head>
     <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
-    <title>Parser</title>
+    <title>LexicalException</title>
     <link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
     <script>var pathToRoot = "../../../";</script>
     <script>document.documentElement.classList.replace("no-js","js");</script>
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-0.0.6            </div>
+0.1.0            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -61,12 +61,12 @@
                 <div class="sidebar--inner" id="sideMenu"></div>
             </div>
             <div id="main">
-<div class="main-content" data-page-type="member" id="content" pageIds="Parkour::io.github.cybercodernaj.parkour/Parser/Parser/#/PointingToDeclaration//769193423">
-  <div class="breadcrumbs"><a href="../../../index.html">Parkour</a><span class="delimiter">/</span><a href="../index.html">io.github.cybercodernaj.parkour</a><span class="delimiter">/</span><a href="index.html">Parser</a><span class="delimiter">/</span><span class="current">Parser</span></div>
+<div class="main-content" data-page-type="member" id="content" pageIds="Parkour::io.github.cybercodernaj.parkour.exceptions/LexicalException/LexicalException/#kotlin.String?#kotlin.Throwable?/PointingToDeclaration//769193423">
+  <div class="breadcrumbs"><a href="../../../index.html">Parkour</a><span class="delimiter">/</span><a href="../index.html">io.github.cybercodernaj.parkour.exceptions</a><span class="delimiter">/</span><a href="index.html">LexicalException</a><span class="delimiter">/</span><span class="current">LexicalException</span></div>
   <div class="cover ">
-    <h1 class="cover"><span><span>Parser</span></span></h1>
+    <h1 class="cover"><span>Lexical</span><wbr></wbr><span><span>Exception</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/Parkour/blob/main/src/main/kotlin/io/github/cybercodernaj/parkour/Parser.kt#L9">source</a>)</span></span></div></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">message<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">cause<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/parkour/tree/main/src/main/kotlin/io/github/cybercodernaj/parkour/exceptions/LexicalException.kt#L12">source</a>)</span></span></div></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span