@brnshkr/config 0.0.1-alpha.8 → 0.0.1-beta.1

package/README.md

@@ -8,6 +8,7 @@
   [![Stars][stars-shield-url]][stars-url]
   [![Forks][forks-shield-url]][forks-url]
   [![Issues][issues-shield-url]][issues-url]
+  [![Release][release-shield-url]][release-url]
 </h1>
 
 Centralized collection of configuration and tooling used across all [@brnshkr][@brnshkr-organization-url] projects.
@@ -17,7 +18,7 @@ _[☄️ Bug Reports / Feature Requests »][issues-url]_
 <!-- omit in toc -->
 ## Table of Contents
 
-<!-- NOTICE: All anchors must not include the emoji to work on github, the ❤️ and ⚙️ for some reason must be url encoded though -->
+<!-- NOTICE: GitHub strips emojis in anchors, but multi-codepoint characters may leave invisible remnants, causing anchors to differ and require URL encoding. -->
 - [👋 About the Project](#-about-the-project)
 - [☕ JS](#-js)
   - [🧰 Prerequisites](#-prerequisites)
@@ -57,7 +58,7 @@ _[☄️ Bug Reports / Feature Requests »][issues-url]_
 
 ### 🧰 Prerequisites
 
-- Node.js >= v24 or Bun >= 1.3 (Older versions may work, but are untested)
+- Node.js >= v24 or Bun >= v1.3 (Older versions may work, but are untested)
 - Any JavaScript package manager (Bun, Yarn, PNPM, NPM)
 
 <p align="right"><a href="#top" title="Back to top">&nbsp;&nbsp;&nbsp;⬆&nbsp;&nbsp;&nbsp;</a></p>
@@ -68,28 +69,28 @@ _[☄️ Bug Reports / Feature Requests »][issues-url]_
 #### Bun
 
 ```sh
-bun a -D @brnshkr/config
+bun a -D -E @brnshkr/config
 ```
 
 <!-- omit in toc -->
 #### Yarn
 
 ```sh
-yarn add -D @brnshkr/config
+yarn add -D -E @brnshkr/config
 ```
 
 <!-- omit in toc -->
 #### PNPM
 
 ```sh
-pnpm add -D @brnshkr/config
+pnpm add -D -E @brnshkr/config
 ```
 
 <!-- omit in toc -->
 #### NPM
 
 ```sh
-npm i -D @brnshkr/config
+npm i -D -E @brnshkr/config
 ```
 
 This repository currently only provides one way to integrate configuration files (An automatic setup is planned, See [🔨 TODOs / Roadmap](#-todos--roadmap)):
@@ -312,8 +313,9 @@ You can then copy the specific configs to your project:
 ##### PHP CS Fixer
 
 ```sh
-cp -v ./vendor/brnshkr/config/conf/.php-cs-fixer.php.example ./conf/.php-cs-fixer.php \
-  && cp -v ./vendor/brnshkr/config/conf/.php-cs-fixer.dist.php.example ./conf/.php-cs-fixer.dist.php
+cp -v ./vendor/brnshkr/config/conf/php-cs-fixer.php.example ./conf/php-cs-fixer.php \
+  && cp -v ./vendor/brnshkr/config/conf/php-cs-fixer.php.example ./conf/php-cs-fixer.php.example \
+  && cp -v ./vendor/brnshkr/config/conf/php-cs-fixer.dist.php.example ./conf/php-cs-fixer.dist.php
 ```
 
 <!-- omit in toc -->
@@ -321,6 +323,7 @@ cp -v ./vendor/brnshkr/config/conf/.php-cs-fixer.php.example ./conf/.php-cs-fixe
 
 ```sh
 cp -v ./vendor/brnshkr/config/conf/rector.php.example ./conf/rector.php \
+  && cp -v ./vendor/brnshkr/config/conf/rector.php.example ./conf/rector.php.example \
   && cp -v ./vendor/brnshkr/config/conf/rector.dist.php.example ./conf/rector.dist.php
 ```
 
@@ -328,8 +331,9 @@ cp -v ./vendor/brnshkr/config/conf/rector.php.example ./conf/rector.php \
 ##### PHPStan
 
 ```sh
-cp -v ./vendor/brnshkr/config/conf/phpstan.neon.example ./conf/phpstan.neon \
-  && cp -v ./vendor/brnshkr/config/conf/phpstan.dist.neon.example ./conf/phpstan.dist.neon
+cp -v ./vendor/brnshkr/config/conf/phpstan.php.example ./conf/phpstan.php \
+  && cp -v ./vendor/brnshkr/config/conf/phpstan.php.example ./conf/phpstan.php.example \
+  && cp -v ./vendor/brnshkr/config/conf/phpstan.dist.php.example ./conf/phpstan.dist.php
 ```
 
 <!-- omit in toc -->
@@ -350,12 +354,15 @@ cp -v ./vendor/brnshkr/config/conf/.gitignore.example ./.gitignore
 ##### All
 
 ```sh
-cp -v ./vendor/brnshkr/config/conf/.php-cs-fixer.php.example ./conf/.php-cs-fixer.php \
-  && cp -v ./vendor/brnshkr/config/conf/.php-cs-fixer.dist.php.example ./conf/.php-cs-fixer.dist.php \
+cp -v ./vendor/brnshkr/config/conf/php-cs-fixer.php.example ./conf/php-cs-fixer.php \
+  && cp -v ./vendor/brnshkr/config/conf/php-cs-fixer.php.example ./conf/php-cs-fixer.php.example \
+  && cp -v ./vendor/brnshkr/config/conf/php-cs-fixer.dist.php.example ./conf/php-cs-fixer.dist.php \
   && cp -v ./vendor/brnshkr/config/conf/rector.php.example ./conf/rector.php \
+  && cp -v ./vendor/brnshkr/config/conf/rector.php.example ./conf/rector.php.example \
   && cp -v ./vendor/brnshkr/config/conf/rector.dist.php.example ./conf/rector.dist.php \
-  && cp -v ./vendor/brnshkr/config/conf/phpstan.neon.example ./conf/phpstan.neon \
-  && cp -v ./vendor/brnshkr/config/conf/phpstan.dist.neon.example ./conf/phpstan.dist.neon \
+  && cp -v ./vendor/brnshkr/config/conf/phpstan.php.example ./conf/phpstan.php \
+  && cp -v ./vendor/brnshkr/config/conf/phpstan.php.example ./conf/phpstan.php.example \
+  && cp -v ./vendor/brnshkr/config/conf/phpstan.dist.php.example ./conf/phpstan.dist.php \
   && cp -v ./vendor/brnshkr/config/conf/Makefile.example ./Makefile \
   && cp -v ./vendor/brnshkr/config/conf/.gitignore.example ./.gitignore
 ```
@@ -370,42 +377,45 @@ Take a look at the function signatures for exact details.
 ##### PHP CS Fixer
 
 ```php
-// ./.php-cs-fixer.dist.php
+// ./php-cs-fixer.dist.php
 
 <?php
 
 declare(strict_types=1);
 
-use Brnshkr\Config\PhpCsFixerConfig;
+use Brnshkr\Config\PhpCsFixer;
 
-return PhpCsFixerConfig::get(/* customize */);
+return PhpCsFixer::getConfig(/* customize */);
 ```
 
 <!-- omit in toc -->
 ##### Rector
 
 ```php
-// ./rector.php
+// ./rector.dist.php
 
 <?php
 
 declare(strict_types=1);
 
-use Brnshkr\Config\RectorConfig;
+use Brnshkr\Config\Rector;
 
-return RectorConfig::get(/* customize */);
+return Rector::getConfig(/* customize */);
 ```
 
 <!-- omit in toc -->
 ##### PHPStan
 
-```yaml
-# phpstan.dist.neon
+```php
+// ./phpstan.dist.php
+
+<?php
 
-includes:
-  - '%currentWorkingDirectory%/vendor/brnshkr/config/conf/phpstan.dist.neon'
+declare(strict_types=1);
+
+use Brnshkr\Config\PhpStan;
 
-# customize
+return PhpStan::getConfig(/* customize */);
 ```
 
 <p align="right"><a href="#top" title="Back to top">&nbsp;&nbsp;&nbsp;⬆&nbsp;&nbsp;&nbsp;</a></p>
@@ -427,7 +437,7 @@ A few possible ways are listed below:
 Example call, adjust as needed
 
 ```sh
-php ./vendor/bin/php-cs-fixer fix -v --show-progress=dots --config ./conf/.php-cs-fixer.php
+php ./vendor/bin/php-cs-fixer fix --config ./conf/php-cs-fixer.php -v --show-progress=dots
 ```
 
 <!-- omit in toc -->
@@ -436,7 +446,7 @@ php ./vendor/bin/php-cs-fixer fix -v --show-progress=dots --config ./conf/.php-c
 Example call, adjust as needed
 
 ```sh
-php ./vendor/bin/rector process --config ./conf/rector.php
+php ./vendor/bin/rector process --config ./conf/rector.php --memory-limit=-1
 ```
 
 <!-- omit in toc -->
@@ -445,7 +455,7 @@ php ./vendor/bin/rector process --config ./conf/rector.php
 Example call, adjust as needed
 
 ```sh
-php ./vendor/bin/phpstan analyze --memory-limit=-1 --configuration ./conf/phpstan.neon
+php ./vendor/bin/phpstan analyze --configuration ./conf/phpstan.php -vv --memory-limit=-1
 ```
 
 <!-- omit in toc -->
@@ -462,7 +472,7 @@ include ./vendor/brnshkr/config/conf/Makefile
 <!-- omit in toc -->
 ###### PHP CS Fixer
 
-Expected configuration file: `./conf/.php-cs-fixer.php`
+Expected configuration file: `./conf/php-cs-fixer.php`
 
 ```sh
 make php-cs-fixer
@@ -480,7 +490,7 @@ make rector
 <!-- omit in toc -->
 ###### PHPStan
 
-Expected configuration file: `./conf/phpstan.neon`
+Expected configuration file: `./conf/phpstan.php`
 
 ```sh
 make phpstan
@@ -516,9 +526,9 @@ Install dependencies and setup project tooling with the following commands and a
 
 ```sh
 composer install \
-  && cp -v ./conf/.php-cs-fixer.php.example ./conf/.php-cs-fixer.php \
+  && cp -v ./conf/php-cs-fixer.php.example ./conf/php-cs-fixer.php \
   && cp -v ./conf/rector.php.example ./conf/rector.php \
-  && cp -v ./conf/phpstan.neon.example ./conf/phpstan.neon
+  && cp -v ./conf/phpstan.php.example ./conf/phpstan.php
 ```
 
 <!-- omit in toc -->
@@ -657,3 +667,7 @@ Distributed under the MIT License. See [LICENSE](./LICENSE) for more information
 
 [issues-url]: https://github.com/brnshkr/config/issues
 [issues-shield-url]: https://img.shields.io/github/issues/brnshkr/config.svg?label=🚨%20issues&style=flat-square&labelColor=%237f399d&color=%23a5097e
+
+<!-- NOTICE: Only use packagist version here since both packages are versioned in sync -->
+[release-url]: https://github.com/brnshkr/config/releases
+[release-shield-url]: https://img.shields.io/packagist/v/brnshkr/config?style=flat-square&label=📦%20npm%2Fpackagist&labelColor=7f399d&color=%23a5097e

package/conf/tsconfig.json

@@ -32,16 +32,14 @@
   ],
   "compilerOptions": {
     // Language and Environment
-    "lib": ["ESNext", "DOM", "DOM.Iterable"],
+    "lib": ["ESNext", "DOM"],
     "moduleDetection": "force",
-    "target": "esnext",
 
     // Modules
     "allowImportingTsExtensions": true,
-    "module": "esnext",
     "moduleResolution": "bundler",
-    "noUncheckedSideEffectImports": true,
     "resolveJsonModule": true,
+    "types": ["bun"],
 
     // Emit
     "noEmit": true,
@@ -55,7 +53,6 @@
     "checkJs": true,
 
     // Interop Constraints
-    "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "verbatimModuleSyntax": true,
 
@@ -68,7 +65,6 @@
     "noPropertyAccessFromIndexSignature": true,
     "noUncheckedIndexedAccess": true,
     "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "strict": true
+    "noUnusedParameters": true
   }
 }