Descargar tslint folders - Descargar el código fuente tslint folders

tslint folders

Otras categorias

v4.1.5

Descargar

? pliegues de tslint

Use Tslint para verificar las importaciones no válidas entre paquetes y carpetas en su proyecto mecanografiado.

Validación automática y documentación de la arquitectura de paquetes (a través de tslint-folders-diagrams ).

Estado - Estable

Tslint-Folders es estable y se usa todos los días en las compilaciones de CI y en las cajas de desarrollo (Linux, Mac, Windows) para al menos un producto importante.

¿por qué?

Ahorre tiempo dedicado a revisar el código manualmente por errores 'tontos' como:

Violaciones de arquitectura:
- Importar desde un paquete o carpeta de 'nivel superior'
- Importar desde carpetas en ambas direcciones
Importar desde una carpeta 'inválida' como 'Dist' o 'Módulos' (feo, y en algunos casos esto puede causar problemas como Webpack que agrupa el mismo código dos veces)
Presionar el código con pruebas deshabilitadas o con código de punto de interrupción
Nombramiento inconsistente de archivos (el file-name-casing de regla TSLint predeterminado solo permite 1 estilo)

características

Utiliza un archivo JSON simple para modelar las relaciones deseadas entre carpetas y subcarpatas
Proporciona una regla de TSLint personalizada que realiza su proyecto mecanografiado, verificando las importaciones que violen el modelo
Otras reglas personalizadas:
- detectar configurablemente las pruebas discapacitadas
- detectar el código de depuración/punto de interrupción
- Detectar las importaciones no válidas de carpetas como 'node_modules' o 'dist'
- Detectar nombres de archivo que no coincidan con el estilo esperado (permite más de 1 estilo de nombre de archivo)
Proporciona una herramienta para generar diagramas de arquitectura del mismo modelo, a través de Tslint-Folders-Diagrams

versiones

Usamos Semver para versiones. Para las versiones disponibles, ver lanzamientos.

uso

1 Instalar a través del hilo en su sitio web

 yarn add tslint-folders

2 Configurar Tslint para recoger las reglas personalizadas

Edite su tslint.json para que tenga una entrada "rulesDirectory" que apunte a Tslint-Folders.

Normalmente esto sería como:

  "rulesDirectory": "./node_modules/tslint-folders/dist/lib/"

Consulte tslint.tslint-Folders.json para obtener un ejemplo.

3 Configurar las reglas

Las reglas TSLint están habilitadas y configuradas en tslint.json .

Consulte la sección Bajo tsf-folders-imports-between-packages en tslint.tslint-Folders.json o las pruebas unitarias para ver ejemplos.

Opcionalmente, puede dividir la configuración de Tslint-Pleas en un archivo separado, como tslint.tslint-folders.json . Para hacer referencia al archivo, agregue este código a tslint.json :

  "extends": "./tslint.tslint-folders.json"

Suponiendo que Tslint ya esté en su lugar, ahora debería ver que las importaciones inesperadas (o pruebas deshabilitadas) sean marcadas por TSLINT. Esto debería funcionar como de costumbre para Tslint: en la línea de comandos, o en un editor como el código visual (puede requerir refrescar el editor).

4 Generar un resumen de la configuración del paquete

Ver Tslint-Folders-Diagrams

Uso de GraphViz para generar diagramas de imagen de la arquitectura

Se puede generar automáticamente un diagrama a partir de la misma configuración utilizada para validar el código:

Diagrama de ejemplo

Consulte Tslint-Folders-Diagrams para más detalles.

Resumen de las reglas personalizadas

Aquí hay un resumen de las reglas personalizadas actuales.

ID de regla	Descripción
TSF-Folders-Disable-Test	Detectar una prueba unitaria deshabilitada, un conjunto de pruebas o prueba de integración.
TSF-Folders-File-Names	Valida la carcasa de los nombres de archivo. Similar a `file-name-casing` de regla estándar, excepto que admite múltiples carcasas permitidas y no permite nombres de archivos con caracteres no válidos (como espacios o comas).
TSF-Folders-Import-from-Disported-Folders	Detectar una importación de una carpeta no estándar como node_modules
TSF-Folders-Imports-between-Packages	Detectar una importación de un paquete de 'nivel superior': por ejemplo, importe de un paquete 'shell' de la aplicación cuando esté dentro de un paquete 'área'. Esta es la principal regla personalizada. También puede detectar cuándo un paquete tiene importaciones utilizando este nombre de paquetes (en lugar de una ruta relativa).
TSF-Folders-test-with-breakpoint	Detectar cuándo una prueba de integración tiene un punto de interrupción como `browser.debug()`

sitios

sitio	Url
Código fuente (GitHub)	https://github.com/mrseanryan/tslint-folders
Página de Github	https://mrseanryan.github.io/tslint-folders/
npm	https://www.npmjs.com/package/tslint-folders

enfoque tomado

Todas las reglas usan el mismo prefijo tsf-folders- .

Para dejar en claro a los desarrolladores que está involucrada una regla personalizada , todos los mensajes de las reglas también incluyen la ID de regla.

Algunas de estas reglas podrían ser reemplazadas por la configuración estándar de TSLINT. Sin embargo, tener reglas personalizadas ofrece mensajes más claros para ayudar al desarrollador a saber qué solucionar (o qué regla deshabilitar para ese código).

Algunas de las reglas no se tratan estrictamente de 'carpetas', sino que se incluyen aquí, ya que también parecen útiles.

Para más detalles y ejemplos, consulte las pruebas unitarias

Construyendo y probando este código fuente

Para trabajar en el código fuente para TSLint-Folders, hay algunos scripts:

dominio	descripción
construcción de hilos	Construye las reglas a la carpeta 'Dist', desde donde se pueden ejecutar.
pelusa	Pelillas El código fuente de las reglas.
Inicio del hilo	Construye, prueba y vincula el código.
prueba de hilo	Prueba las reglas contra los archivos de especificaciones (*.lint)
prueba de hilo	Pruebe una sola regla contra los archivos de especificaciones (*.lint)

pruebas unitarias

Las pruebas unitarias para la regla tsf-folders-imports-between-packages están aquí.

Las pruebas unitarias usan datos de prueba para verificar los límites del paquete de un sitio web bastante típico.

La configuración coincidente se puede ver en tslint.tslint-Folders.json

Datos de prueba: paquetes

Los datos de prueba se basan en un sitio web que utiliza múltiples paquetes:

Nombre del paquete	Descripción
caparazón	El shell de la aplicación: este es el paquete de nivel superior y puede importar desde cualquier otro paquete.
del área	Un área de 'aplicación TODO' del sitio web, que está alojada dentro del shell. No debe importar desde la carcasa o de otros paquetes de 'área'.
contacto	Un área de 'Información de contacto' del sitio web, que está alojada dentro del shell. No debe importar desde la carcasa o de otros paquetes de 'área'.
paquete de cuadrícula	Una cuadrícula de UI que es utilizada por paquetes de área. No debe importar ningún otro paquete reconocido.
tensiones	Un paquete 'utiliza' utilizado por los paquetes de shell y de área. No debe importar ningún otro paquete reconocido.

Validación de ejemplo : 'Shell' debería poder importar desde 'TODO-AREA', pero no al revés (el shell está en un nivel más alto de abstracción y también desea evitar dependencias de 2 vías).

Datos de prueba: paquetes con subcarpetas

Los plateadores de Tslint también pueden validar las importaciones entre subcarpetas de un paquete.

El paquete de 'área de TODO-AREA' de prueba está configurado con subcarpetas bastante típicas como 'componentes' y 'modelos'. Tslint.tslint-Folders.json se ha configurado para verificar las importaciones entre estas carpetas.

Nombre de subfolder	Descripción
componentes	Carpeta de nivel superior de componentes de la interfaz de usuario. Puede importar desde cualquiera de las otras carpetas reconocidas.
Viewmodels	Carpeta de modelos de vista, utilizados por los componentes de la interfaz de usuario. Solo puede importar de modelos o utilidades.
modelos	Carpeta de modelos, utilizada por los modelos View. Solo puede importar de Utils.
tensiones	Una carpeta de 'utilización'. No debe importar ninguna otra carpeta reconocida.

Validación de ejemplo : 'Componentes' deberían poder importar de 'modelos', pero no de la manera revelada (los componentes están en un nivel más alto de abstracción y también quieren evitar dependencias de 2 vías).