Merge pull request #2 from moser-jose/shortname

moser-jose · web-flow · commit 0eeadaa7f49e · 2025-03-04T08:42:27.000-03:00
update the shortname
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 node_modules/
 dist/
+coverage/
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,5 @@
+node_modules/
+dist/
+coverage/
+package-lock.json
+*.d.ts 
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,11 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "endOfLine": "lf"
+} 
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,10 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        
+
+    ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,15 @@
+{
+	"editor.formatOnSave": true,
+	"editor.codeActionsOnSave": {
+		"source.fixAll.eslint": "explicit"
+	},
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"eslint.validate": ["typescript", "javascript"],
+	"editor.diagnostics.enabled": true,
+	"typescript.reportStyleChecksAsWarnings": true,
+	"editor.quickSuggestions": {
+		"other": true,
+		"comments": false,
+		"strings": false
+	}
+}
diff --git a/README.md b/README.md
@@ -2,7 +2,17 @@
 
 `shortname-js` is a JavaScript function designed to shorten names (Portuguese - PT 🇵🇹 | BR 🇧🇷 | AO 🇦🇴) in a simple and user-friendly way. The function allows users to quickly enter full names and receive abbreviated versions of those names in return.
 
-[![The MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT) [![The MIT License](https://img.shields.io/github/package-json/v/moser-jose/shortname-js)](https://github.com/moser-jose/shortname-js)
+[![The MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT) 
+[![Version](https://img.shields.io/github/package-json/v/moser-jose/shortname-js)](https://github.com/moser-jose/shortname-js)
+[![npm](https://img.shields.io/npm/v/@mosmmy/shortname-js)](https://www.npmjs.com/package/@mosmmy/shortname-js)
+[![npm downloads](https://img.shields.io/npm/dm/@mosmmy/shortname-js)](https://www.npmjs.com/package/@mosmmy/shortname-js)
+[![npm bundle size](https://img.shields.io/bundlephobia/min/@mosmmy/shortname-js)](https://bundlephobia.com/package/@mosmmy/shortname-js)
+[![TypeScript](https://img.shields.io/badge/TypeScript-supported-blue)](https://www.typescriptlang.org/)
+[![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)
+[![Jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://jestjs.io/)
+[![Coverage Status](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](https://github.com/moser-jose/shortname-js)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
+[![GitHub stars](https://img.shields.io/github/stars/moser-jose/shortname-js?style=social)](https://github.com/moser-jose/shortname-js/stargazers)
 
 ## Install
 
@@ -18,11 +28,13 @@
 
 ```javascript
 
-import shortName = '@mosmmy/shortname-js'
+import { shortName } from '@mosmmy/shortname-js'
 
 console.log(shortName('Jorge Pedro André dos Santos'))          //Jorge P. A. dos Santos
 
-console.log(shortName('Pedro de Sousa André'))                  //**Pedro** S. André
+console.log(shortName('Pedro de Sousa André'))                  //Pedro de S. André
+
+console.log(shortName('Marilda dos Santos Pedro de Souza'))     //Marilda dos S. P. de Souza
 
 console.log(shortName('Marcos Ângelo Mateus dos Santos'))       //Marcos A. M. dos Santos
 ```
@@ -31,6 +43,8 @@ To run the test:
 
 `npm run test`
 
+`npm run test:**coverage**`
+
 ## Licence
 
 This project is governed by the [MIT](/LICENSE.md). Just remember to be a nice person and send back any modifications, corrections or improvements. ✌️
diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -1 +1 @@
-export default function shortName(fullName: string): string | undefined;
+export declare function shortName(fullName: string): string | undefined;
diff --git a/dist/index.js b/dist/index.js
@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = shortName;
+exports.shortName = shortName;
 const PREPOSITIONS = ['de', 'do', 'dos', 'da', 'das', 'e'];
 const normalized = (name) => {
     return name.normalize("NFD")
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,36 @@
+import tsParser from '@typescript-eslint/parser'
+import tsPlugin from '@typescript-eslint/eslint-plugin'
+import prettierPlugin from 'eslint-plugin-prettier'
+import eslintJs from '@eslint/js'
+import globals from 'globals'
+
+export default [
+  eslintJs.configs.recommended,
+  {
+    files: ['**/*.{ts,js}'],
+    languageOptions: {
+      parser: tsParser,
+      ecmaVersion: 2021,
+      sourceType: 'module',
+      globals: {
+        ...globals.jest,
+      },
+    },
+    plugins: {
+      '@typescript-eslint': tsPlugin,
+      prettier: prettierPlugin,
+    },
+    rules: {
+      ...tsPlugin.configs.recommended.rules,
+      'prettier/prettier': 'error',
+      '@typescript-eslint/explicit-function-return-type': 'warn',
+      '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+      'no-console': ['error', { allow: ['warn', 'error'] }],
+      'no-alert': 'error',
+      'no-unreachable': 'error',
+    },
+  },
+  {
+    ignores: ['node_modules/**', 'dist/**', 'coverage/**', '**/*.d.ts'],
+  },
+]
diff --git a/jest.config.js b/jest.config.js
@@ -1,5 +1,17 @@
-module.exports = {
+export default {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testMatch: ['**/tests/*.test.ts'],
-}; 
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
+    ],
+  },
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/src/index.ts b/src/index.ts
diff --git a/src/tests/index.test.ts b/src/tests/index.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`node_modules/`
`2`	`2`	`dist/`
	`3`	`+coverage/`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-export default function shortName(fullName: string): string \| undefined;`
	`1`	`+export declare function shortName(fullName: string): string \| undefined;`