Palavras PT-br

Código criado com o intuito de ajudar a ter uma lista de todas as palavras em português brasileiro

O que é?

Um pacote com uma listagem de palavras em português brasileiro

Instalação

Instale o pacote globalmente através do repositório npmjs.com.

npm i @andsfonseca/palavras-pt-br

Uso

Importação

Para realizar a importação via Javascript

var Word = require('@andsfonseca/palavras-pt-br').Word;

Para realizar a importação via Typescript

import { Word } from '@andsfonseca/palavras-pt-br'

Funções

• getAllWords (limit: number = 0, removeAccents: boolean = true, includeCompounds: boolean = true, includeSpecialCharacters: boolean = false, includeProperNouns: boolean = false)

Método que retorna um array de palavras da base com a filtragem escolhida pelo usuário.

| Argumento | Descrição | Obrigatório | |:------------------------:|:--------------------------------------------------------------------------------------:|:-------------------:| | limit | Limite de caracteres da palavra, caso seja menor ou igual a 0 serão considerada todas. | Não, padrão 0 | | removeAccents | Informa se deve remover os acentos nas palavras. | Não, padrão false | | includeCompounds | Informa se deve incluir palavras compostas. | Não, padrão true | | includeSpecialCharacters | Informa se deve incluir palavras com caracateres especiais. | Não, padrão false | | includeProperNouns | Informa se deve incluir nomes próprios. | Não, padrão false |

let words: string[] = Word.getAllWords()

• getRandomWord (limit: number = 0, removeAccents: boolean = true, includeCompounds: boolean = true, includeSpecialCharacters: boolean = false, includeProperNouns: boolean = false)

Método que retorna uma palavra aleatória da base com a filtragem escolhida pelo usuário.

Os argumentos são descritos no método getAllWords

let randomWord: string = Word.getRandomWord()

• getDailyWord (limit: number = 0, removeAccents: boolean = true, includeCompounds: boolean = true, includeSpecialCharacters: boolean = false, includeProperNouns: boolean = false)

Método que retorna uma palavra aleatória por dia da base com a filtragem escolhida pelo usuário.

Os argumentos são descritos no método getAllWords

let randomWord: string = Word.getDailyWord()

• checkValid (word: string, limit: number = 0, removeAccents: boolean = true, includeCompounds: boolean = true, includeSpecialCharacters: boolean = false, includeProperNouns: boolean = false)

Método que verifica se uma palavra está na base, com a filtragem escolhida pelo usuário.

| Argumento | Descrição | Obrigatório | |:------------------------:|:-------------------------:|:-------------------:| | word | Palavra a ser verificada. | ✅ Sim |

O restante dos argumentos são descritos no método getAllWords

let valid: boolean = Word.checkValid("teste")

• wordleValidator(trueWord: string, triedWord: string)

Método que verifica a proximidade entre duas palavras, no estilo Wordle. Retorna informações sobre a validação da palavra

| Argumento | Descrição | Obrigatório | |:------------------------:|:-------------------------:|:-------------------:| | trueWord | Palavra verdadeira. | ✅ Sim | | triedWord | Palavra a ser verificada. | ✅ Sim |

let validation: IWordleValidation[] = Word.wordleValidator("tesla", "testu")

A interface IWordleValidation é descrita nesta seção

Interfaces

• IWordleValidation

Representação da Validação do Wordle

interface IWordleValidation {
    word: string,
    contains: boolean,
    exact: boolean
}

| Propriedade | Descrição | |:--------------------:|:-------------------------:| | word | Letra. | | contains | Se a letra está na palavra. | | exact | Se a letra está na posição correta. |

Base de Dados

Bases Padrões

As bases de dados usados nesta biblioteca são:

| Dicionário | |:--------------------:| | Dicionário br.ispell | | pythonprobr | | @un-versed Termoo v2 |

Podem ser importadas da seguinte maneira

import { BRISPELL, PYTHONPROBR, UNVERSEDV2 } from '@andsfonseca/palavras-pt-br'

Por padrão a biblioteca @un-versed Termoo v2 é usada.

Você pode customizar a biblioteca da seguinte maneira:

Word.library = PYTHONPROBR
//Word.library = ["Outras", "Palavras", "Da", "Sua", "Base"]

Issues

Sinta-se livre para contribuir com o projeto.

Contribuições

1. Crie uma cópia do projeto (fork)
2. Crie uma branch com sua modificação (git checkout -b my-new-resource)
3. Faça um commit commit (git commit -am 'Adding a new resource...')
4. Push (git push origin my-new-resource)
5. Crie uma Pull Request