stencil icon indicating copy to clipboard operation
stencil copied to clipboard

[vsc-extension] [C4GT] Stencil VSCode extension

Open techsavvyash opened this issue 1 year ago • 27 comments

Create VSCode Extension for Stencil - Data Verification Feature

Description

The goal is to develop the first version of a VSCode extension for Stencil, aiming to enhance the Developer Experience (DX). The primary feature for this initial release is to verify data intended for seeding in the database against the model generated by the Prisma client. This verification will be conducted using CSV or JSON files.

Goals

  1. VSCode Extension Setup: Establish the basic structure and setup for the VSCode extension tailored for Stencil.

  2. Data Verification Feature: Implement the feature that allows users to verify data from CSV/JSON files against the Prisma client-generated model.

Acceptance Criteria

  1. Extension Setup: Successfully set up the VSCode extension project with Stencil integration.

  2. Data Verification Functionality: Implement functionality within the extension that verifies data present in CSV/JSON files against the Prisma client-generated model.

  3. User Interface (UI): Develop a simple and user-friendly UI within VSCode to facilitate the data verification process.

  4. Testing: Ensure the data verification feature works as intended and is capable of identifying inconsistencies between the provided data and the Prisma model.

  5. Documentation: Provide clear documentation on how to use the VSCode extension, specifically focusing on the steps for data verification and any relevant considerations. Include your docs as a ReadME.md in your PR. The docs will be pushed to official stencil documentation after successful merging of your PR.

Checklist (To be filled by the developer)

  • [ ] Set up the basic structure and configuration for the Stencil VSCode extension.

  • [ ] Implement the data verification feature, allowing users to check data from CSV/JSON files against the Prisma client-generated model.

  • [ ] Design and implement a simple and user-friendly UI within VSCode for the data verification process.

  • [ ] Perform thorough testing to ensure the accuracy and effectiveness of the data verification feature.

  • [ ] Document the usage of the VSCode extension, emphasizing the steps for data verification and any important information for users.

Product Name

Stencil

Organisation Name

SamagraX

Tech Skills Needed

TypeScript

Mentors

@RyanWalker277

Complexity

Hard

Domain

Category

Miscellaneous

Sub Category

VsCode Extensions

techsavvyash avatar Dec 02 '23 08:12 techsavvyash