Merge pull request #12 from levisantosp/main

Author: k0d13

.changeset/wise-comics-buy.md

@@ -0,0 +1,5 @@
+---
+"enhanced-ms": minor
+---
+
+Add support for Portuguese

README.md

@@ -50,19 +50,20 @@ As mentioned above, `enhanced-ms` is an enhanced version of the popular [`ms`](h
 
 The currently supported languages include:
 
-| Language             | Key   |
-| -------------------- | ----- |
-| English (default)    | en    |
-| German               | de    |
-| Russian              | ru    |
-| Māori                | mi    |
-| Spanish              | es    |
-| Dutch                | nl    |
-| Italian              | it    |
-| French               | fr    |
-| Czech                | cs    |
-| Polish               | pl    |
-| Chinese (Simplified) | zh-CN |
+| Language              | Key   |
+| --------------------- | ----- |
+| English (default)     | en    |
+| German                | de    |
+| Russian               | ru    |
+| Māori                 | mi    |
+| Spanish               | es    |
+| Dutch                 | nl    |
+| Italian               | it    |
+| French                | fr    |
+| Czech                 | cs    |
+| Polish                | pl    |
+| Portuguese            | pt    |
+| Chinese (Simplified)  | zh-CN |
 
 You can help by adding support for more languages.
 

src/languages/index.ts

@@ -9,6 +9,7 @@ import it from './it';
 import mi from './mi';
 import nl from './nl';
 import pl from './pl';
+import pt from './pt';
 import ru from './ru';
 import zhCN from './zh-CN';
 
@@ -23,6 +24,7 @@ type Locale =
   | 'mi'
   | 'nl'
   | 'pl'
+  | 'pt'
   | 'ru'
   | 'zh-CN';
 type Languages = Record<Locale, LanguageDefinition>;
@@ -36,6 +38,7 @@ export const languages: Languages = {
   mi,
   nl,
   pl,
+  pt,
   ru,
   'zh-CN': zhCN,
 };

src/languages/pt.ts

@@ -0,0 +1,72 @@
+export default {
+  decimal: ',',
+  and: 'e',
+
+  units: {
+    nanosecond: {
+      name: (c) => (c === 1 ? 'nanossegundo' : 'nanossegundos'),
+      abbreviation: 'ns',
+      matches: ['nanossegundo', 'nanossegundos', 'ns'],
+    },
+    microsecond: {
+      name: (c) => (c === 1 ? 'microssegundo' : 'microssegundos'),
+      abbreviation: 'μs',
+      matches: ['microssegundo', 'microssegundos', 'μs'],
+    },
+    millisecond: {
+      name: (c) => (c === 1 ? 'milissegundo' : 'milissegundos'),
+      abbreviation: 'ms',
+      matches: ['milissegundo', 'milissegundos', 'ms'],
+    },
+    second: {
+      name: (c) => (c === 1 ? 'segundo' : 'segundos'),
+      abbreviation: 's',
+      matches: ['segundo', 'segundos', 's'],
+    },
+    minute: {
+      name: (c) => (c === 1 ? 'minuto' : 'minutos'),
+      abbreviation: 'm',
+      matches: ['minuto', 'minutos', 'm'],
+    },
+    hour: {
+      name: (c) => (c === 1 ? 'hora' : 'horas'),
+      abbreviation: 'h',
+      matches: ['hora', 'horas', 'h'],
+    },
+    day: {
+      name: (c) => (c === 1 ? 'dia' : 'dias'),
+      abbreviation: 'd',
+      matches: ['dia', 'dias', 'd'],
+    },
+    week: {
+      name: (c) => (c === 1 ? 'semana' : 'semanas'),
+      abbreviation: 'sem',
+      matches: ['semana', 'semanas', 'sem'],
+    },
+    month: {
+      name: (c) => (c === 1 ? 'mês' : 'meses'),
+      abbreviation: 'me',
+      matches: ['mês', 'meses', 'me'],
+    },
+    year: {
+      name: (c) => (c === 1 ? 'ano' : 'anos'),
+      abbreviation: 'a',
+      matches: ['ano', 'anos', 'a'],
+    },
+    decade: {
+      name: (c) => (c === 1 ? 'década' : 'décadas'),
+      abbreviation: 'dec',
+      matches: ['década', 'décadas', 'dec'],
+    },
+    century: {
+      name: (c) => (c === 1 ? 'século' : 'séculos'),
+      abbreviation: 'sec',
+      matches: ['século', 'séculos', 'sec'],
+    },
+    millennium: {
+      name: (c) => (c === 1 ? 'milênio' : 'milênios'),
+      abbreviation: 'mil',
+      matches: ['milênio', 'milênios', 'mil'],
+    },
+  },
+} satisfies import('./helpers/definition-types').LanguageDefinition;

tests/pt.test.ts

@@ -0,0 +1,64 @@
+import { createMs } from 'enhanced-ms';
+import { describe, expect, it } from 'vitest';
+
+const ms = createMs({ language: 'pt' });
+
+describe('Portuguese', () => {
+  describe('format milliseconds', () => {
+    it('formats milliseconds with default options', () => {
+      expect(ms(90061)).toBe('1 minuto 30 segundos');
+      expect(ms(90061000)).toBe('1 dia 1 hora 1 minuto 1 segundo');
+    });
+
+    it('returns null for sub one second with default options', () => {
+      expect(ms(0)).toBeNull();
+    });
+
+    it('format using short preset', () => {
+      expect(ms(90061, 'short')).toBe('1m 30s');
+      expect(ms(90061000, 'short')).toBe('1d 1h');
+    });
+
+    it('format using colon notation preset', () => {
+      expect(ms(90061, 'colonNotation')).toBe('01:30');
+      expect(ms(90061000, 'colonNotation')).toBe('25:01:01');
+    });
+
+    it('formats with use abbreviations', () => {
+      const options = { useAbbreviations: true };
+      expect(ms(90061, options)).toBe('1m 30s');
+      expect(ms(90061000, options)).toBe('1d 1h 1m 1s');
+    });
+
+    it('formats with unit limit', () => {
+      const options = { unitLimit: 1 };
+      expect(ms(90061, options)).toBe('1 minuto');
+      expect(ms(90061000, options)).toBe('1 dia');
+    });
+  });
+
+  describe('parse duration', () => {
+    it('parses durations', () => {
+      expect(ms('1 minuto 30 segundos')).toBe(90000);
+      expect(ms('1m 30s')).toBe(90000);
+      expect(ms('1 minuto 30 segundos 61 milissegundos')).toBe(90061);
+      expect(ms('1m 30s 61ms')).toBe(90061);
+    });
+
+    it('parses portuguese-specific unit names and abbreviations', () => {
+      expect(ms('2 meses')).toBe(2 * 2_628_000_000);
+      expect(ms('2 semanas')).toBe(2 * 604_800_000);
+      expect(ms('2sem')).toBe(2 * 604_800_000);
+    });
+
+    it('parses accented portuguese unit names correctly', () => {
+      expect(ms('2 séculos')).toBe(2 * 3_153_600_000_000);
+      expect(ms('2 milênios')).toBe(2 * 31_536_000_000_000);
+    });
+
+    it('returns zero for invalid durations', () => {
+      expect(ms('nyr9341')).toBe(0);
+      expect(ms('o4utrc89nyt')).toBe(0);
+    });
+  });
+});