first commit

Author: junaid-travelopia

.gitignore

@@ -0,0 +1,18 @@
+# --- Windows and Mac files
+[Tt]humbs.db
+.DS_Store
+
+# --- Root
+/*
+!.github
+!.gitignore
+!configs
+!rules
+!index.js
+!README.md
+!LICENSE
+!package.json
+!package-lock.json
+
+# -- Rules
+!Travelopia-WordPress

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Travelopia
+
+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.

README.md

@@ -0,0 +1,23 @@
+# Travelopia WordPress JavaScript Coding Standards
+
+![maintenance-status](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)
+
+Official Travelopia WordPress JavaScript coding standards.
+
+<table width="100%">
+	<tr>
+		<td align="left" width="70%">
+            <p>Built by the super talented team at <strong><a href="https://www.travelopia.com/work-with-us/">Travelopia</a></strong>.</p>
+		</td>
+		<td align="center" width="30%">
+			<img src="https://www.travelopia.com/wp-content/themes/travelopia/assets/svg/logo-travelopia-circle.svg" width="50" />
+		</td>
+	</tr>
+</table>
+
+## Installation
+Install the library via NPM:
+
+```
+$ npm install @travelopia/eslint-plugin-wordpress-coding-standards --save-dev
+```

configs/default.js

@@ -0,0 +1,26 @@
+module.exports = {
+	plugins: [ '@travelopia/wordpress-coding-standards' ],
+	extends: 'plugin:@wordpress/eslint-plugin/recommended-with-formatting',
+	overrides: [
+		{
+			'files': [ '*.ts', '*.tsx' ],
+			'rules': {
+				'no-undef': 'off',
+				'no-unused-vars': 'off',
+				'import/named': 'off',
+				'import/no-unresolved': 'off',
+				'import/no-extraneous-dependencies': 'off'
+			}
+		}
+	],
+	rules: {
+		'react-hooks/rules-of-hooks': 'off',
+		'react-hooks/exhaustive-deps': 'off',
+		'@travelopia/wordpress-coding-standards/comment-before-code-block': 'error',
+		'@travelopia/wordpress-coding-standards/first-line-function-comment': 'error',
+		'@travelopia/wordpress-coding-standards/comment-before-return': 'error',
+		'@travelopia/wordpress-coding-standards/empty-line-before-comment': 'error',
+		'@travelopia/wordpress-coding-standards/empty-line-before-control': 'error',
+		'@travelopia/wordpress-coding-standards/file-first-line-doc-comment': 'error',
+	}
+};

index.js

@@ -0,0 +1,13 @@
+module.exports = {
+	configs: {
+		'default': require( './configs/default' ),
+	},
+	rules: {
+		'comment-before-code-block': require( './rules/comment-before-code-block' ),
+		'first-line-function-comment': require( './rules/first-line-function-comment' ),
+		'comment-before-return': require( './rules/comment-before-return' ),
+		'empty-line-before-comment': require( './rules/empty-line-before-comment' ),
+		'empty-line-before-control': require( './rules/empty-line-before-control' ),
+		'file-first-line-doc-comment': require( './rules/file-first-line-doc-comment' ),
+	},
+};