feat(stats): collect drill stats

package.json

@@ -28,6 +28,7 @@
  "@tracespace/plotter": "workspace:*",
  "@tracespace/www": "workspace:*",
  "@tracespace/xml-id": "workspace:*",
+ "@tracespace/stats": "workspace:*",
  "whats-that-gerber": "workspace:*"
  },
  "devDependencies": {

packages/stats/.npmignore

@@ -0,0 +1,2 @@
+*.tsbuildinfo
+__tests__

packages/stats/README.md

@@ -0,0 +1,18 @@
+# @tracespace/stats
+
+A drill stats collector for [@tracespace/parser][] ASTs.
+
+Part of the [tracespace][] collection of PCB visualization tools.
+
+**This package is still in development and is not yet published.**
+
+## usage
+
+```js
+import {createParser} from '@tracespace/parser'
+import {collectDrillStats} from '@tracespace/stats'
+
+const syntaxTree = createParser().feed(/* ...some gerber string... */).result()
+
+const stats = collectDrillStats([syntaxTree])
+```

packages/stats/package.json

@@ -0,0 +1,50 @@
+{
+ "name": "@tracespace/stats",
+ "publishConfig": {
+ "access": "public"
+ },
+ "version": "0.0.0-unreleased",
+ "description": "Collect drill statistics for PCB fabrication files.",
+ "main": "./dist/tracespace-plotter.umd.cjs",
+ "module": "./dist/tracespace-plotter.es.js",
+ "types": "./lib/index.d.ts",
+ "exports": {
+ ".": {
+ "types": "./lib/index.d.ts",
+ "source": "./src/index.ts",
+ "import": "./dist/tracespace-stats.es.js",
+ "require": "./dist/tracespace-stats.umd.cjs"
+ }
+ },
+ "type": "module",
+ "sideEffects": false,
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/tracespace/tracespace.git",
+ "directory": "packages/stats"
+ },
+ "scripts": {
+ "build": "vite build",
+ "clean": "rimraf dist"
+ },
+ "keywords": [
+ "gerber",
+ "excellon",
+ "pcb",
+ "circuit",
+ "hardware",
+ "electronics"
+ ],
+ "contributors": [
+ "KN4CK3R <[email protected]> (https://www.oldschoolhack.me)",
+ "Mike Cousins <[email protected]> (https://mike.cousins.io)"
+ ],
+ "license": "MIT",
+ "bugs": {
+ "url": "https://github.com/tracespace/tracespace/issues"
+ },
+ "homepage": "https://github.com/tracespace/tracespace#readme",
+ "dependencies": {
+ "@tracespace/parser": "workspace:*"
+ }
+}

packages/stats/src/__tests__/stats.test.ts

@@ -0,0 +1,41 @@
+import {describe, it, expect} from 'vitest'
+import {createParser} from '@tracespace/parser'
+import {collectDrillStats, DrillStats} from '..'
+
+describe('@tracespace/stats', () => {
+ it('should return an empty result', () => {
+ const expected: DrillStats = {
+ drillHits: [],
+ drillRoutes: [],
+ totalDrills: 0,
+ totalRoutes: 0,
+ minDrillSize: 0,
+ maxDrillSize: 0,
+ }
+
+ expect(collectDrillStats([])).to.eql(expected)
+ })
+
+ it('should collect drill stats', () => {
+ const parser = createParser()
+ parser.feed(
+ 'M48\nM72\nINCH,TZ\nT01C0.0240\nT02C0.0335\n%\nG90\nT01\nX16910Y10810\nX15010Y12410\nX15100Y14300\nT02\nX26450Y10700\nT1\nG00X0Y0\nG01X2500Y2500\nG01X5000Y0\nM30\n'
+ )
+
+ const tree = parser.result()
+
+ const expected: DrillStats = {
+ drillHits: [
+ {count: 3, diameter: 0.024},
+ {count: 1, diameter: 0.0335},
+ ],
+ drillRoutes: [{count: 2, diameter: 0.024}],
+ totalDrills: 4,
+ totalRoutes: 2,
+ minDrillSize: 0.024,
+ maxDrillSize: 0.0335,
+ }
+
+ expect(collectDrillStats([tree])).to.eql(expected)
+ })
+})

packages/stats/src/index.ts

@@ -0,0 +1,159 @@
+import * as Parser from '@tracespace/parser'
+
+export interface DrillUsage {
+ diameter: number
+ count: number
+}
+
+export interface DrillStats {
+ drillHits: DrillUsage[]
+ drillRoutes: DrillUsage[]
+ totalDrills: number
+ totalRoutes: number
+ minDrillSize: number
+ maxDrillSize: number
+}
+
+/**
+ * Method to collect drill stats of parsed drill files.
+ *
+ * @example
+ * ```ts
+ * import {createParser} from '@tracespace/parser'
+ * import {collectDrillStats} from '@tracespace/stats'
+ *
+ * const parser = createParser()
+ *
+ * parser.feed(...)
+ *
+ * const tree = parser.results()
+ * const stats = collectDrillStats([tree])
+ * ```
+ *
+ * @category Stats
+ */
+export function collectDrillStats(trees: Parser.Root[]): DrillStats {
+ const state: DrillStatsState = {
+ usedTools: {},
+ drillsPerTool: {},
+ routesPerTool: {},
+ minDrillSize: null,
+ maxDrillSize: null,
+ }
+
+ for (const tree of trees) {
+ if (tree.filetype !== Parser.DRILL) {
+ continue
+ }
+
+ _updateDrillStats(state, tree)
+ }
+
+ let totalDrills = 0
+ const drillHits: DrillUsage[] = []
+ for (const [key, count] of Object.entries(state.drillsPerTool)) {
+ totalDrills += count
+ drillHits.push({
+ diameter: state.usedTools[key],
+ count,
+ })
+ }
+
+ let totalRoutes = 0
+ const drillRoutes: DrillUsage[] = []
+ for (const [key, count] of Object.entries(state.routesPerTool)) {
+ totalRoutes += count
+ drillRoutes.push({
+ diameter: state.usedTools[key],
+ count,
+ })
+ }
+
+ const stats: DrillStats = {
+ drillHits,
+ drillRoutes,
+ totalDrills,
+ totalRoutes,
+ minDrillSize: state.minDrillSize ?? 0,
+ maxDrillSize: state.maxDrillSize ?? 0,
+ }
+
+ return stats
+}
+
+interface DrillStatsState {
+ usedTools: Record<string, number>
+ drillsPerTool: Record<string, number>
+ routesPerTool: Record<string, number>
+ minDrillSize: number | null
+ maxDrillSize: number | null
+}
+
+function _updateDrillStats(state: DrillStatsState, tree: Parser.Root) {
+ let currentTool = null
+ let currentMode: Parser.InterpolateModeType = Parser.DRILL
+ for (const node of tree.children) {
+ switch (node.type) {
+ case Parser.TOOL_DEFINITION: {
+ currentTool = node.code
+
+ if (node.shape.type !== Parser.CIRCLE) {
+ continue
+ }
+
+ const {diameter} = node.shape
+
+ state.usedTools[currentTool] = diameter
+
+ if (state.minDrillSize === null || diameter < state.minDrillSize) {
+ state.minDrillSize = diameter
+ }
+
+ if (state.maxDrillSize === null || diameter > state.maxDrillSize) {
+ state.maxDrillSize = diameter
+ }
+
+ break
+ }
+
+ case Parser.TOOL_CHANGE:
+ currentTool = node.code
+ break
+ case Parser.INTERPOLATE_MODE:
+ currentMode = node.mode
+ break
+ case Parser.GRAPHIC:
+ if (currentTool === null) {
+ continue
+ }
+
+ if (node.graphic === null) {
+ switch (currentMode) {
+ case Parser.DRILL: {
+ const drillCount = state.drillsPerTool[currentTool] ?? 0
+ state.drillsPerTool[currentTool] = drillCount + 1
+ break
+ }
+
+ case Parser.LINE:
+ case Parser.CW_ARC:
+ case Parser.CCW_ARC: {
+ const routeCount = state.routesPerTool[currentTool] ?? 0
+ state.routesPerTool[currentTool] = routeCount + 1
+ break
+ }
+
+ default:
+ break
+ }
+ } else if (node.graphic === Parser.SLOT) {
+ const routeCount = state.routesPerTool[currentTool] ?? 0
+ state.routesPerTool[currentTool] = routeCount + 1
+ }
+
+ break
+ default:
+ break
+ }
+ }
+}

packages/stats/tsconfig.json

@@ -0,0 +1,11 @@
+{
+ "extends": "../../config/tsconfig.base.json",
+ "references": [{"path": "../parser"}],
+ "compilerOptions": {
+ "composite": true,
+ "emitDeclarationOnly": true,
+ "rootDir": "src",
+ "outDir": "lib"
+ },
+ "include": ["src"]
+}

packages/stats/vite.config.ts

@@ -0,0 +1,22 @@
+import {defineConfig} from 'vite'
+
+import {baseConfig, libraryFilename} from '../../config/vite.config.base'
+
+export default defineConfig({
+ ...baseConfig,
+ build: {
+ lib: {
+ entry: 'src/index.ts',
+ name: 'TracespaceStats',
+ fileName: libraryFilename('tracespace-stats'),
+ },
+ rollupOptions: {
+ external: ['@tracespace/parser'],
+ output: {
+ globals: {
+ '@tracespace/parser': 'TracespaceParser',
+ },
+ },
+ },
+ },
+})