Skip to content

Commit 02f5629

Browse files
rubensdemelorubensdemelo
authored
Merge pull request #2 from flutterbootcamp/add-documentation
docs: Add comprehensive documentation to the repository
2 parents 4c3b921 + 1245193 commit 02f5629

File tree

3 files changed

+398
-136
lines changed

3 files changed

+398
-136
lines changed

‎README.md‎

Lines changed: 85 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,102 @@
1+
# brasil_datetime 🇧🇷
12

2-
# brasil_datetime
3+
Extensões para a classe `DateTime` que facilitam a formatação de data e hora para o padrão brasileiro (pt_BR).
34

4-
Extensões para a classe `DateTime` para facilitar a formatação em pt_BR 🇧🇷.
5+
[![Dart](https://github.com/flutterbootcamp/brasil_datetime/actions/workflows/dart.yml/badge.svg)](https://github.com/flutterbootcamp/brasil_datetime/actions/workflows/dart.yml)
6+
[![Codecov](https://img.shields.io/codecov/c/github/flutterbootcamp/brasil_datetime)](https://codecov.io/gh/flutterbootcamp/brasil_datetime)
57

6-
![Codecov](https://img.shields.io/codecov/c/github/flutterbootcamp/brasil_datetime)
8+
## Visão Geral
79

8-
[![Dart](https://github.com/flutterbootcamp/brasil_datetime/actions/workflows/dart.yml/badge.svg)](https://github.com/flutterbootcamp/brasil_datetime/actions/workflows/dart.yml)
10+
Este pacote oferece um conjunto de extensões para a classe `DateTime` do Dart, permitindo a formatação de datas e horas de maneira simples e intuitiva, seguindo as convenções brasileiras.
11+
12+
## Instalação
13+
14+
Adicione `brasil_datetime` ao seu arquivo `pubspec.yaml`:
15+
16+
```yaml
17+
dependencies:
18+
brasil_datetime: ^0.3.5
19+
```
920
10-
## Apresentação
21+
Em seguida, importe o pacote em seu código Dart:
1122
12-
Este package facilita a manipulação de objetos `DateTime` de acordo com o padrão e formato brasileiro.
23+
```dart
24+
import 'package:brasil_datetime/brasil_datetime.dart';
25+
```
1326

14-
## Extensões
27+
## Como Usar
1528

16-
Para qualquer objeto `DateTime`, as extensões abaixos estão disponíveis:
29+
As extensões estão disponíveis diretamente em qualquer objeto `DateTime`.
1730

1831
```dart
19-
// objeto de exemplo
20-
final data = DateTime(1987, 4, 22, 23, 37, 06);
21-
22-
data.diaMesAno(); // 22/04/1987
23-
data.diaMesAnoHoraMinuto(); // 22/04/1987 23:37
24-
data.dia(); // 22
25-
data.diaSemana(); // quarta-feira
26-
data.diaSemanaAbrev(); // qua.
27-
data.mes(); // abril
28-
data.mesAbrev(); // abr.
29-
data.mesNoAno(); // 4
30-
data.diaMes(); // 22/4
31-
data.diaMesAbrev(); // 22 de abr.
32-
data.diaSemanaMesAbrev(); // qua., 22 de abr.
33-
data.diaSemanaEMes(); // qua., 22/04
34-
data.diaMesExt(); // 22 de abril
35-
data.diaSemanaMesExt(); // quarta-feira, 22 de abril
36-
data.trimestreAbrev(); // T2
37-
data.trimestre(); // 2º trimestre
38-
data.ano(); // 1987
39-
data.anoMes(); // 04/1987
40-
data.semanaDiaMesAnoAbrev(); // qua., 22/04/1987
41-
data.mesAnoAbrev(); // abr. de 1987
42-
data.diaMesAnoAbrev(); // 22 de abr. de 1987
43-
data.semanaDiaMesAnoExtAbrev(); // qua., 22 de abr. de 1987
44-
data.mesAnoExt(); // abril de 1987
45-
data.diaMesAnoExt(); // 22 de abril de 1987
46-
data.semanaDiaMesAnoExt(); // quarta-feira, 22 de abril de 1987
47-
data.trimestreAnoAbrev(); // T2 de 1987
48-
data.hora(); // 23
49-
data.horaMinuto(); // 23:37
50-
data.minuto(); // 37
51-
data.segundo(); // 6
52-
data.minutoSegundo(); // 37:06
32+
void main() {
33+
final agora = DateTime.now();
34+
35+
// Exemplo de uso
36+
print('Data completa: ${agora.diaMesAno()}'); // Saída: 25/10/2023
37+
print('Dia por extenso: ${agora.diaSemana()}'); // Saída: quarta-feira
38+
print('Mês por extenso: ${agora.mesExt()}'); // Saída: outubro
39+
}
5340
```
41+
42+
## Extensões Disponíveis
43+
44+
Abaixo estão todas as extensões disponíveis para formatação.
45+
46+
### Data
47+
48+
| Método | Descrição | Exemplo (para `DateTime(1987, 4, 22)`) |
49+
| --------------------- | ------------------------------------------------- | -------------------------------------- |
50+
| `dia()` | Dia do mês | `22` |
51+
| `diaSemana()` | Nome do dia da semana | `quarta-feira` |
52+
| `diaSemanaAbrev()` | Nome abreviado do dia da semana | `qua.` |
53+
| `mes()` | Nome do mês | `abril` |
54+
| `mesAbrev()` | Nome abreviado do mês | `abr.` |
55+
| `mesNoAno()` | Número do mês no ano | `4` |
56+
| `diaMes()` | Dia e mês (`dd/MM`) | `22/04` |
57+
| `diaMesAbrev()` | Dia e mês abreviado (`dd 'de' MMM`) | `22 de abr.` |
58+
| `diaSemanaEMes()` | Dia da semana e mês (`EEE, dd/MM`) | `qua., 22/04` |
59+
| `diaMesExt()` | Dia e mês por extenso (`d 'de' MMMM`) | `22 de abril` |
60+
| `diaSemanaMesExt()` | Dia da semana e mês por extenso | `quarta-feira, 22 de abril` |
61+
| `trimestreAbrev()` | Trimestre abreviado (`T1`, `T2`, etc.) | `T2` |
62+
| `trimestre()` | Trimestre por extenso | `2º trimestre` |
63+
| `ano()` | Ano (`yyyy`) | `1987` |
64+
| `anoMes()` | Mês e ano (`MM/yyyy`) | `04/1987` |
65+
| `diaMesAno()` | Data completa (`dd/MM/yyyy`) | `22/04/1987` |
66+
| `semanaDiaMesAnoAbrev()`| Data com dia da semana abreviado | `qua., 22/04/1987` |
67+
| `mesAnoAbrev()` | Mês abreviado e ano (`MMM 'de' yyyy`) | `abr. de 1987` |
68+
| `diaMesAnoAbrev()` | Data com mês abreviado | `22 de abr. de 1987` |
69+
| `semanaDiaMesAnoExtAbrev()`| Data com dia e mês abreviados | `qua., 22 de abr. de 1987` |
70+
| `mesAnoExt()` | Mês por extenso e ano (`MMMM 'de' yyyy`) | `abril de 1987` |
71+
| `diaMesAnoExt()` | Data com mês por extenso | `22 de abril de 1987` |
72+
| `semanaDiaMesAnoExt()`| Data completa por extenso | `quarta-feira, 22 de abril de 1987` |
73+
| `trimestreAnoAbrev()` | Trimestre abreviado e ano (`QQQ 'de' yyyy`) | `T2 de 1987` |
74+
75+
### Hora
76+
77+
| Método | Descrição | Exemplo (para `DateTime(..., 23, 37, 06)`) |
78+
| ------------------- | ------------------------------------- | ------------------------------------------ |
79+
| `hora()` | Hora (`HH`) | `23` |
80+
| `horaMinuto()` | Hora e minuto (`HH:mm`) | `23:37` |
81+
| `horaMinutoSegundo()`| Hora, minuto e segundo (`HH:mm:ss`) | `23:37:06` |
82+
| `minuto()` | Minuto (`mm`) | `37` |
83+
| `segundo()` | Segundo (`ss`) | `06` |
84+
| `minutoSegundo()` | Minuto e segundo (`mm:ss`) | `37:06` |
85+
86+
### Data e Hora
87+
88+
| Método | Descrição | Exemplo (para `DateTime(1987, 4, 22, 23, 37)`) |
89+
| ---------------------- | --------------------------------------- | ---------------------------------------------- |
90+
| `diaMesAnoHoraMinuto()`| Data e hora (`dd/MM/yyyy HH:mm`) | `22/04/1987 23:37` |
91+
5492
---
5593

94+
## Contribuidores
95+
96+
Agradecemos a todos que contribuíram para este projeto!
97+
5698
<a href="https://github.com/flutterbootcamp/brasil_datetime/graphs/contributors">
5799
<img src="https://contrib.rocks/image?repo=flutterbootcamp/brasil_datetime" />
58100
</a>
59101

60-
Made with [contrib.rocks](https://contrib.rocks).
102+
Feito com [contrib.rocks](https://contrib.rocks).

‎example/pubspec.lock‎

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,18 @@ packages:
55
dependency: transitive
66
description:
77
name: _fe_analyzer_shared
8-
sha256: "16e298750b6d0af7ce8a3ba7c18c69c3785d11b15ec83f6dcd0ad2a0009b3cab"
8+
sha256: da0d9209ca76bde579f2da330aeb9df62b6319c834fa7baae052021b0462401f
99
url: "https://pub.dev"
1010
source: hosted
11-
version: "76.0.0"
12-
_macros:
13-
dependency: transitive
14-
description: dart
15-
source: sdk
16-
version: "0.3.3"
11+
version: "85.0.0"
1712
analyzer:
1813
dependency: transitive
1914
description:
2015
name: analyzer
21-
sha256: "1f14db053a8c23e260789e9b0980fa27f2680dd640932cae5e1137cce0e46e1e"
16+
sha256: "974859dc0ff5f37bc4313244b3218c791810d03ab3470a579580279ba971a48d"
2217
url: "https://pub.dev"
2318
source: hosted
24-
version: "6.11.0"
19+
version: "7.7.1"
2520
args:
2621
dependency: transitive
2722
description:
@@ -52,7 +47,7 @@ packages:
5247
path: ".."
5348
relative: true
5449
source: path
55-
version: "0.3.4"
50+
version: "0.3.5"
5651
clock:
5752
dependency: transitive
5853
description:
@@ -125,14 +120,6 @@ packages:
125120
url: "https://pub.dev"
126121
source: hosted
127122
version: "2.1.2"
128-
http:
129-
dependency: transitive
130-
description:
131-
name: http
132-
sha256: b9c29a161230ee03d3ccf545097fccd9b87a5264228c5d348202e0f0c28f9010
133-
url: "https://pub.dev"
134-
source: hosted
135-
version: "1.2.2"
136123
http_multi_server:
137124
dependency: transitive
138125
description:
@@ -153,10 +140,10 @@ packages:
153140
dependency: transitive
154141
description:
155142
name: intl
156-
sha256: "00f33b908655e606b86d2ade4710a231b802eec6f11e87e4ea3783fd72077a50"
143+
sha256: "3df61194eb431efc39c4ceba583b95633a403f46c9fd341e550ce0bfa50e9aa5"
157144
url: "https://pub.dev"
158145
source: hosted
159-
version: "0.20.1"
146+
version: "0.20.2"
160147
io:
161148
dependency: transitive
162149
description:
@@ -189,14 +176,6 @@ packages:
189176
url: "https://pub.dev"
190177
source: hosted
191178
version: "1.2.0"
192-
macros:
193-
dependency: transitive
194-
description:
195-
name: macros
196-
sha256: "1d9e801cd66f7ea3663c45fc708450db1fa57f988142c64289142c9b7ee80656"
197-
url: "https://pub.dev"
198-
source: hosted
199-
version: "0.1.3-main.0"
200179
matcher:
201180
dependency: transitive
202181
description:

0 commit comments

Comments
 (0)