@langri-sha/projen-project 0.2.0 → 0.3.0

package/CHANGELOG.json

@@ -2,7 +2,22 @@
   "name": "@langri-sha/projen-project",
   "entries": [
     {
-      "date": "Tue, 30 Apr 2024 23:02:26 GMT",
+      "date": "Wed, 01 May 2024 23:11:10 GMT",
+      "version": "0.3.0",
+      "tag": "@langri-sha/projen-project_v0.3.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-project",
+            "commit": "71b1eccec703fc7903cea5182a198e66f5c765ce",
+            "comment": "feat(project): Add EditorConfig support"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 30 Apr 2024 23:02:33 GMT",
       "version": "0.2.0",
       "tag": "@langri-sha/projen-project_v0.2.0",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,20 @@
 # Change Log - @langri-sha/projen-project
 
-This log was last generated on Tue, 30 Apr 2024 23:02:26 GMT and should not be manually modified.
+This log was last generated on Wed, 01 May 2024 23:11:10 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.3.0
+
+Wed, 01 May 2024 23:11:10 GMT
+
+### Minor changes
+
+- feat(project): Add EditorConfig support (filip.dupanovic@gmail.com)
+
 ## 0.2.0
 
-Tue, 30 Apr 2024 23:02:26 GMT
+Tue, 30 Apr 2024 23:02:33 GMT
 
 ### Minor changes
 

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@langri-sha/projen-project",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "MIT",
   "type": "module",
   "main": "src/index.ts",
   "dependencies": {
-    "@langri-sha/projen-lint-synthesized": "0.1.0",
+    "@langri-sha/projen-editorconfig": "0.2.0",
+    "@langri-sha/projen-lint-synthesized": "0.1.1",
     "beachball": "2.43.1",
     "ramda": "0.29.1"
   },

package/src/__snapshots__/index.test.ts.snap

@@ -136,6 +136,84 @@ module.exports = {
 }
 `;
 
+exports[`with EditorConfig options 1`] = `
+{
+  ".editorconfig": "# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+
+root=true
+
+[*]
+charset=utf-8
+end_of_line=lf
+indent_style=space
+indent_size=2
+insert_final_newline=true
+trim_trailing_whitespace=true
+
+[Dockerfile]
+indent_style=tab
+",
+  ".gitignore": "# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+.*
+!.babelrc
+!.dockerignore
+!.editorconfig
+!.eslintignore
+!.eslintrc.js
+!.gitattributes
+!.gitignore
+!.gitkeep
+!.husky
+!.npmignore
+!.openssl
+!.prettierignore
+!.projenrc*
+*.db
+*.log
+!.github/
+!.husky/
+!.projen/
+dist/
+local/
+node_modules/
+!/.gitattributes
+!/.projen/tasks.json
+!/.projen/deps.json
+!/.projen/files.json
+!/.editorconfig
+",
+  ".projen/files.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "files": [
+      ".editorconfig",
+      ".gitattributes",
+      ".gitignore",
+      ".projen/deps.json",
+      ".projen/files.json",
+      ".projen/tasks.json",
+    ],
+  },
+  ".projen/tasks.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "tasks": {
+      "default": {
+        "description": "Synthesize project files",
+        "name": "default",
+        "steps": [
+          {
+            "exec": "node --loader ts-node/esm .projenrc.mts",
+          },
+        ],
+      },
+      "test": {
+        "description": "Run tests",
+        "name": "test",
+      },
+    },
+  },
+}
+`;
+
 exports[`with Terraform enabled 1`] = `
 {
   ".gitignore": "# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".

package/src/index.test.ts

@@ -20,6 +20,15 @@ test('with Beachball configuration', () => {
   expect(synthSnapshot(project)).toMatchSnapshot()
 })
 
+test('with EditorConfig options', () => {
+  const project = new Project({
+    name: 'test-project',
+    editorConfigOptions: {},
+  })
+
+  expect(synthSnapshot(project)).toMatchSnapshot()
+})
+
 test('with Terraform enabled', () => {
   const project = new Project({
     name: 'test-project',

package/src/index.ts

@@ -12,6 +12,10 @@ import {
   LintSynthesized,
   type LintSynthesizedOptions,
 } from '@langri-sha/projen-lint-synthesized'
+import {
+  EditorConfig,
+  type EditorConfigOptions,
+} from '@langri-sha/projen-editorconfig'
 
 export interface ProjectOptions extends BaseProjectOptions {
   /*
@@ -19,6 +23,11 @@ export interface ProjectOptions extends BaseProjectOptions {
    */
   beachballConfig?: BeachballConfig
 
+  /**
+   * EditorConfig options.
+   */
+  editorConfigOptions?: EditorConfigOptions
+
   /*
    * Options for the linting synthesized files.
    */
@@ -57,6 +66,7 @@ export class Project extends BaseProject {
 
     this.#configureBeachball(options)
     this.#configureDefaultTask()
+    this.#configureEditorConfig(options)
     this.#configureLintSynthesized(options)
     this.#createPnpmWorkspaces(options)
   }
@@ -107,6 +117,29 @@ export class Project extends BaseProject {
     )
   }
 
+  #configureEditorConfig({ editorConfigOptions }: ProjectOptions) {
+    if (!editorConfigOptions) {
+      return
+    }
+
+    const defaults: EditorConfigOptions = {
+      '*': {
+        // eslint-disable-next-line unicorn/text-encoding-identifier-case
+        charset: 'utf-8',
+        end_of_line: 'lf',
+        indent_style: 'space',
+        indent_size: 2,
+        insert_final_newline: true,
+        trim_trailing_whitespace: true,
+      },
+      Dockerfile: {
+        indent_style: 'tab',
+      },
+    }
+
+    new EditorConfig(this, deepMerge(editorConfigOptions ?? {}, defaults))
+  }
+
   #createPnpmWorkspaces({ workspaces }: ProjectOptions) {
     if (!workspaces) {
       return

package/tsconfig.json

@@ -7,6 +7,7 @@
   },
   "references": [
     { "path": "../jest-test" },
+    { "path": "../projen-editorconfig" },
     { "path": "../projen-lint-synthesized" },
     { "path": "../tsconfig" }
   ]