Estructuración de una biblioteca publicable
Organice lib, src y la API pública
Estructuración de una biblioteca publicable es una lección gratuita de Dart Academy en CoddyKit. Esta es la lección 1 de 4. Puedes leer la lección completa abajo gratuitamente — luego la practicas en el navegador con un editor de código integrado y un tutor de IA 24/7. Forma parte de la ruta de aprendizaje de Dart Academy, y tu progreso se sincroniza en la web y la app de CoddyKit. El curso de Dart Academy incluye 4 lecciones en total.
Un paquete es solo una carpeta
Un package de Dart que se puede publicar es simplemente una carpeta con un pubspec.yaml en la raíz. Ese único archivo convierte el código común en algo que pub.dev puede alojar. 📦
La carpeta lib es el espacio público
Todo lo que quiera que los usuarios importen debe estar dentro de lib. Los archivos directamente ubicados en lib forman parte de la superficie pública del paquete, así que colóquelos con cuidado.
Ocultar los elementos internos en lib/src
El código que no quiera exponer debe ir en lib/src. Por convención, estos archivos son detalles de implementación privados y no están pensados para que los usuarios los importen directamente.
lib/
my_package.dart
src/
helper.dartEl archivo de entrada
La mayoría de los paquetes incluye un archivo principal en lib con el nombre del paquete. Este entry point es el que los usuarios importan para obtener toda la biblioteca de una vez.
import 'package:my_package/my_package.dart';Volver a exportar con la palabra clave export
El punto de entrada usa export para exponer las partes de lib/src que los usuarios realmente necesitan. Así, usted define una API pública limpia e intencionada.
export 'src/calculator.dart';
export 'src/parser.dart';Decidir deliberadamente la API pública
El conjunto de nombres que exporta constituye su public API. Manténgalo pequeño y estable, porque cada símbolo exportado es una promesa para sus usuarios.
Los guiones bajos indican privacidad
En Dart, los nombres que comienzan con un guion bajo son library-private. Incluso dentro de lib/src, anteponga un guion bajo a los auxiliares que nunca quiera exponer.
int _internalCount = 0;La carpeta example
Añada una carpeta example con un pequeño programa ejecutable. Muestra a los usuarios cómo funciona su paquete y le otorga puntos en pub.dev. ✨
Las pruebas van en test
Las pruebas automatizadas se guardan en la carpeta test, fuera de lib. No se envían a los usuarios, pero demuestran que el paquete funciona como se espera.
Los archivos de nivel superior importan
Una buena raíz de paquete también incluye un README, un CHANGELOG y una LICENSE. Estos tres archivos son lo primero que pub.dev muestra a los visitantes.
Una vista general de la estructura
Al organizarlo todo, la structure funciona como un mapa: lib para la API, src para los elementos internos, además de example, test y los archivos de metadatos.
my_package/
lib/
example/
test/
pubspec.yamlComprobación rápida
¿Dónde coloca el código que debe seguir siendo un detalle de implementación interno?
Resumen: una biblioteca ordenada
Ha aprendido la layout: lib contiene la API pública, lib/src oculta los elementos internos y export define lo que ven los usuarios. Primero la estructura y después la publicación. 🚀
Preguntas frecuentes
¿La lección «Estructuración de una biblioteca publicable» es gratis?
Sí — el texto completo de «Estructuración de una biblioteca publicable» es gratis para leer aquí en la web. Para practicarla de forma interactiva (editor de código integrado y tutor de IA 24/7) y desbloquear el resto del curso de Dart Academy, actualiza a CoddyKit PRO. El curso de Dart Academy incluye 4 lecciones en total.
¿Qué aprenderé en «Estructuración de una biblioteca publicable»?
Organice lib, src y la API pública Practicas Dart Academy con código real que ejecutas directamente en el navegador, y un tutor de IA 24/7 responde tus preguntas mientras trabajas en la lección.
¿Necesito experiencia previa para empezar Dart Academy?
No se requiere experiencia previa. Dart Academy en CoddyKit está estructurado para principiantes hasta estudiantes avanzados, así que puedes empezar aquí o desde el inicio y avanzar a tu ritmo. Esta es la lección 1 de 4.
¿Cuánto tiempo toma la lección «Estructuración de una biblioteca publicable»?
La mayoría de las lecciones de CoddyKit toman alrededor de 5–10 minutos. Cada una es compacta e interactiva, así que avanzas constantemente y retomas exactamente por donde dejaste en la web y la app.
¿Puedo escribir y ejecutar código en esta lección de Dart Academy?
Sí. Cada lección de Dart Academy incluye un editor de código integrado, así que escribes y ejecutas código real directamente en tu navegador y obtienes retroalimentación instantánea de IA — sin configuración local necesaria.
Todas las lecciones de este curso
- Estructuración de una biblioteca publicable
- Documentación con comentarios dartdoc
- Linting, formateo y puntuación de pana
- dart pub publish en pub.dev