chore: remove todo comment of tsdoc

kmkzt · Jun 14, 2022 · 0c17b9c · 0c17b9c
1 parent a2613bb
commit 0c17b9c
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 19 deletions.
diff --git a/examples/react/next.config.js b/examples/react/next.config.js
@@ -2,11 +2,4 @@ module.exports = {
   // For gh-pages
   basePath: process.env.BASE_PATH || '',
   assetPrefix: process.env.BASE_PATH || '',
-  webpack(config, { dev }) {
-    /**
-     * @todo Add eslint-webpack-plugin.
-     *   https://github.com/webpack-contrib/eslint-webpack-plugin
-     */
-    return config
-  },
 }
diff --git a/packages/animation/src/animation.test.ts b/packages/animation/src/animation.test.ts
@@ -23,7 +23,7 @@ describe('animation.ts', () => {
       })
       expect(svg.generateFrame().length).toBe(1)
     })
-    // TODO: Improve test pattern
+    // TODO Improve test pattern
     it('toAnimationElement', () => {
       const svg = generateAniamtion()
       const testAnimation: FrameAnimation = (paths, count) => {

diff --git a/packages/animation/src/animation.ts b/packages/animation/src/animation.ts
@@ -25,7 +25,7 @@ export class SvgAnimation {
   public svg: Svg
   public renderer: Renderer
   public resizeHandler: ResizeHandler
-  /** Relation animate element TODO: add easing option */
+  /** Relation animate element */
   private _repeatCount: string
   constructor(
     el: HTMLElement,
@@ -228,7 +228,7 @@ export class SvgAnimation {
     )
   }
 
-  /** @param filename TODO: Support gif and apng */
+  /** @param filename */
   public download(filename?: string): void {
     downloadBlob({
       data: svg2base64(this.toElement().outerHTML),

diff --git a/packages/core/src/drawing.test.ts b/packages/core/src/drawing.test.ts
@@ -48,7 +48,7 @@ describe('drawing.ts', () => {
       expect(el).toMatchSnapshot()
     })
 
-    /** TODO: Fix NaN */
+    // TODO: Fix NaN
     it('undo()', () => {
       const draw: SvgDrawing = new SvgDrawing(document.createElement('div'))
       draw.drawStart()

diff --git a/packages/core/src/renderer.ts b/packages/core/src/renderer.ts
@@ -76,7 +76,7 @@ export class Renderer {
     const { width, height } = el.getBoundingClientRect()
     el.appendChild(svgObjectToElement({ background, width, height, paths: [] }))
   }
-  /** Render TODO: XSS test TODO: Partially renderable */
+
   public update(svgObj: SvgObject): void {
     this.el.replaceChild(svgObjectToElement(svgObj), this.el.childNodes[0])
   }

diff --git a/packages/core/src/svg.test.ts b/packages/core/src/svg.test.ts
@@ -124,7 +124,6 @@ describe('svg.ts', () => {
         path.parseCommandString(testData)
         expect(path.getCommandString()).toBe(testData)
       })
-      // TODO: Validate command
       it.skip('failed pattern', () => {
         path.parseCommandString('M a b')
         expect(path.getCommandString()).toBe('')
@@ -173,7 +172,6 @@ describe('svg.ts', () => {
     let svg: Svg
     beforeEach(() => {
       svg = new Svg({ width: 500, height: 500 })
-        // TODO: rewrite bezier curve test
         .addPath(
           new Path()
             .addCommand(new Command(COMMAND_TYPE.MOVE, [0, 0]))
@@ -228,7 +226,6 @@ describe('svg.ts', () => {
         new Svg({ width: 400, height: 400 }).parseSVGElement(svgEl)
       ).toMatchSnapshot()
     })
-    // TODO: Fix width, height
     it('toJson', () => {
       expect(svg.toJson()).toMatchSnapshot()
     })

diff --git a/packages/core/src/svg.ts b/packages/core/src/svg.ts
@@ -143,8 +143,8 @@ export class Vector {
 }
 
 /**
- * TODO: refactor command. The following commands are not supported. Cannot
- * support commands that use `M` or` z` more than once `M 0 0 L 1 1 Z M 1 1 L 2 2 Z`
+ * Cannot support commands that use `M` or` z` more than once `M 0 0 L 1 1 Z M 1
+ * 1 L 2 2 Z`
  */
 export class Path {
   public attrs: PathObject
@@ -254,7 +254,7 @@ export class Svg {
     this.background = background
   }
 
-  /** @todo Check height */
+  // TODO: Resize from height
   public resize({ width, height }: { width: number; height: number }) {
     this.scalePath(width / this.width)
     this.width = width

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -1,4 +1,4 @@
-/** Svg Path JSON TODO: improve key types */
+/** Svg Path JSON */
 export type PathObject = {
   [camelCase: string]: string | undefined
 }