Girishbari / comic-cult

Transform your stories into captivating comic art with dialogue effortlessly! this project harnesses the power of GeminiAI and stable diffusion for processing and generating stunning images and dialogues
16 stars 22 forks source link

🚀 [Feature Request] - Conversion of Javascript code to Typescript code in server & app modules #22

Closed prabh1234assla closed 1 month ago

prabh1234assla commented 1 month ago

Why Ts and why not pure vanilla js?

TypeScript stands out from vanilla JavaScript with its outstanding features like static typing, interfaces, enums, generics, union types, type guards, and decorators. These features collectively enhance code quality, readability, and maintainability, while also significantly reducing the occurrence of bugs and errors. By providing a more structured and expressive way to write code, TypeScript empowers developers to build complex applications with confidence, offering a smoother development experience and facilitating collaboration within teams.

Why I am the right fit for this project I've successfully utilized TypeScript across projects integrating React-Three/Fiber, React-Three/drei, Three.js and React Spring into Next.js for immersive 3D websites, implemented WebRTC and sockets in TypeScript codebases, and built scalable solutions with Gatsby, GraphQL, and TypeScript, all with a focus on robustness and efficiency. I think I have required know-how on how to handle the TypeScript codebases.

Here is how I will handle my js to ts conversion

  1. Install TypeScript: I will begin by installing TypeScript globally using npm or yarn. npm install -g typescript

  2. Rename Files: Change the file extensions of all JavaScript files to TypeScript files. For JSX files, I will change the extension to .tsx.

  3. Enable TypeScript Configuration: If project doesn't have a tsconfig.json file, I will create one using the following command: tsc --init

  4. Start Converting: Begin converting my JavaScript code to TypeScript by following these steps:

let firstName: string = 'John';
let age: number = 30;

function add(a: number, b: number): number {
  return a + b;
}
interface Person {
  firstName: string;
  lastName: string;
  age: number;
}

let person: Person = {
  firstName: 'John',
  lastName: 'Doe',
  age: 30,
};
enum Color {
  Red,
  Green,
  Blue,
}

let c: Color = Color.Green;
console.log(c); // Output: 1
function identity<T>(arg: T): T {
  return arg;
}

let output = identity<string>('hello');
console.log(output); // Output: hello
let value: string | number;
value = 'hello';
console.log(value); // Output: hello
value = 42;
console.log(value); // Output: 42
function printName(name: string | string[]): void {
  if (typeof name === 'string') {
    console.log(name.toUpperCase());
  } else {
    console.log(name.join(', '));
  }
}

printName('John'); // Output: JOHN
printName(['John', 'Doe']); // Output: John, Doe
let x = 3; // TypeScript infers that x is of type number
console.log(x); // Output: 3
interface Person {
  firstName: string;
  lastName?: string;
}

let person: Person = {
  firstName: 'John',
};

console.log(person.lastName?.toUpperCase()); // Output: undefined
@sealed
class BugReport {
  type = "report";
  title: string;

  constructor(t: string) {
    this.title = t;
  }
}

function sealed(constructor: Function) {
  Object.seal(constructor);
  Object.seal(constructor.prototype);
}

When @sealed is executed, it will seal both the constructor and its prototype, and will therefore prevent any further functionality from being added to or removed from this class during runtime by accessing BugReport.prototype or by defining properties on BugReport itself.

Additional things I will consider While converting the Js codebase to Ts codebase :

  1. Resolve Compilation Errors: As I convert your code, TypeScript might raise compilation errors due to type inconsistencies or other issues. I will make sure to address these errors one by one by refining your type annotations and ensuring compatibility with TypeScript's type system.

  2. Incremental Adoption: If the codebase is extensive, I will consider adopting TypeScript incrementally. I will start by converting individual modules or components and gradually expand the TypeScript coverage across the project.

  3. Testing and Validation: Test the TypeScript code thoroughly to ensure it behaves as expected. Use TypeScript's type system to catch errors early in the development process, reducing the likelihood of runtime issues.

  4. Continuous Integration: Integrate TypeScript conversion into continuous integration pipeline to ensure that new changes adhere to TypeScript standards and do not introduce regressions.

  5. Documentation and Training: Update project documentation to familiarize team members with TypeScript features.

Girishbari commented 1 month ago

Hey, @prabh1234assla, it's really fascinating that you know ts very well, converting js to ts is in the list of doings, but before that I was thinking to make this repo a monorepo, this will separate both our application and can provide more structured view. There is already a issue made for this, if you're comfortable you can take it..

prabh1234assla commented 1 month ago

okay @Girishbari i am fascinated to see your response and yes I am comfortable in doing so. Can u assign me this MONOREPO task. I will be amazed to take and work on it.